ilUserCertificateGUI Class Reference

Collaboration diagram for ilUserCertificateGUI:

Public Member Functions
	__construct (?ilGlobalTemplateInterface $template=null, ?ilCtrlInterface $ctrl=null, ?ilLanguage $language=null, ?ilObjUser $user=null, ?ilUserCertificateRepository $userCertificateRepository=null, ?ServerRequestInterface $request=null, ?ilLogger $certificateLogger=null, ?ilSetting $certificateSettings=null, ?Factory $uiFactory=null, ?Renderer $uiRenderer=null, ?ilAccessHandler $access=null, ?Filesystem $filesystem=null)
	executeCommand ()
	listCertificates ()
	download ()

Data Fields
const	SORTATION_SESSION_KEY = 'my_certificates_sorting'

Protected Member Functions
	getCurrentSortation ()
	applySortation ()

Protected Attributes
ilSetting	$certificateSettings
Factory	$uiFactory
Renderer	$uiRenderer
ilAccessHandler	$access
array	$sortationOptions
string	$defaultSorting = 'date_DESC'

Private Member Functions
	getDefaultCommand ()

Private Attributes
ilGlobalTemplateInterface	$template
ilCtrlInterface	$ctrl
ilLanguage	$language
ilUserCertificateRepository	$userCertificateRepository
ilObjUser	$user
ServerRequestInterface	$request
ilLogger	$certificateLogger
Filesystem	$filesystem

Detailed Description

Author

Niels Theen nthee.nosp@m.n@da.nosp@m.tabay.nosp@m..de @ilCtrl_IsCalledBy ilUserCertificateGUI: ilAchievementsGUI

Definition at line 31 of file class.ilUserCertificateGUI.php.

Constructor & Destructor Documentation

__construct()

ilUserCertificateGUI::__construct	(	?ilGlobalTemplateInterface	$template = null,
		?ilCtrlInterface	$ctrl = null,
		?ilLanguage	$language = null,
		?ilObjUser	$user = null,
		?ilUserCertificateRepository	$userCertificateRepository = null,
		?ServerRequestInterface	$request = null,
		?ilLogger	$certificateLogger = null,
		?ilSetting	$certificateSettings = null,
		?Factory	$uiFactory = null,
		?Renderer	$uiRenderer = null,
		?ilAccessHandler	$access = null,
		?Filesystem	$filesystem = null
	)

Definition at line 54 of file class.ilUserCertificateGUI.php.

      {
        global $DIC;
 
        $logger = $DIC->logger()->cert();
 
        if ($template === null) {
            $template = $DIC->ui()->mainTemplate();
        }
        $this->template = $template;
 
        if ($ctrl === null) {
            $ctrl = $DIC->ctrl();
        }
        $this->ctrl = $ctrl;
 
        if ($language === null) {
            $language = $DIC->language();
        }
        $this->language = $language;
 
        if ($user === null) {
            $user = $DIC->user();
        }
        $this->user = $user;
 
        if ($request === null) {
            $request = $DIC->http()->request();
        }
        $this->request = $request;
 
        if ($certificateLogger === null) {
            $certificateLogger = $DIC->logger()->cert();
        }
        $this->certificateLogger = $certificateLogger;
 
        if ($certificateSettings === null) {
            $certificateSettings = new ilSetting("certificate");
        }
        $this->certificateSettings = $certificateSettings;
 
        if (null === $uiFactory) {
            $uiFactory = $DIC->ui()->factory();
        }
        $this->uiFactory = $uiFactory;
 
        if (null === $uiRenderer) {
            $uiRenderer = $DIC->ui()->renderer();
        }
        $this->uiRenderer = $uiRenderer;
 
        if (null === $access) {
            $access = $DIC->access();
        }
        $this->access = $access;
 
        if (null === $filesystem) {
            $filesystem = $DIC->filesystem()->web();
        }
        $this->filesystem = $filesystem;
 
        if ($userCertificateRepository === null) {
            $userCertificateRepository = new ilUserCertificateRepository(null, $this->certificateLogger);
        }
        $this->userCertificateRepository = $userCertificateRepository;
 
        $this->language->loadLanguageModule('cert');
        $this->language->loadLanguageModule('cert');
    }

References $access, $certificateLogger, $certificateSettings, $ctrl, $DIC, $filesystem, $language, $request, $template, $uiFactory, $uiRenderer, $user, $userCertificateRepository, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\filesystem(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

applySortation()

ilUserCertificateGUI::applySortation ( )

protected

Exceptions

ilWACException
ilDateTimeException

Definition at line 307 of file class.ilUserCertificateGUI.php.

                                       : void
    {
        $sorting = $this->request->getQueryParams()['sort_by'] ?? $this->defaultSorting;
        if (!array_key_exists($sorting, $this->sortationOptions)) {
            $sorting = $this->defaultSorting;
        }
        ilSession::set(self::SORTATION_SESSION_KEY, $sorting);
 
        $this->listCertificates();
    }

References $defaultSorting, listCertificates(), and ilSession\set().

Here is the call graph for this function:

download()

ilUserCertificateGUI::download

(

)

Exceptions

ilException

Definition at line 321 of file class.ilUserCertificateGUI.php.

                              : void
    {
        global $DIC;
 
        $user = $this->user;
        $language = $DIC->language();
 
        $pdfGenerator = new ilPdfGenerator($this->userCertificateRepository, $this->certificateLogger);
 
        $userCertificateId = (int) $this->request->getQueryParams()['certificate_id'];
 
        try {
            $userCertificate = $this->userCertificateRepository->fetchCertificate($userCertificateId);
            if ($userCertificate->getUserId() !== $user->getId()) {
                throw new ilException(sprintf(
                    'User "%s" tried to access certificate: "%s"',
                    $user->getLogin(),
                    $userCertificateId
                ));
            }
        } catch (ilException $exception) {
            $this->certificateLogger->warning($exception->getMessage());
            $this->template->setOnScreenMessage('failure', $language->txt('cert_error_no_access'));
            $this->listCertificates();
            return;
        }
 
        $pdfAction = new ilCertificatePdfAction(
            $this->certificateLogger,
            $pdfGenerator,
            new ilCertificateUtilHelper(),
            $this->language->txt('error_creating_certificate_pdf')
        );
 
        $pdfAction->downloadPdf($userCertificate->getUserId(), $userCertificate->getObjId());
 
        $this->listCertificates();
    }

References $DIC, $language, $user, ilObject\getId(), ilObjUser\getLogin(), ILIAS\Repository\int(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), listCertificates(), and ilLanguage\txt().

Here is the call graph for this function:

executeCommand()

ilUserCertificateGUI::executeCommand

(

)

Definition at line 141 of file class.ilUserCertificateGUI.php.

                                    : bool
    {
        $nextClass = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
 
        if (!$this->certificateSettings->get('active', '0')) {
            $this->ctrl->returnToParent($this);
        }
 
        $this->template->setTitle($this->language->txt('obj_cert'));
 
        switch ($nextClass) {
            default:
                if (!method_exists($this, $cmd)) {
                    $cmd = $this->getDefaultCommand();
                }
                $this->{$cmd}();
        }
 
        return true;
    }

References ILIAS\Repository\ctrl(), getDefaultCommand(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Here is the call graph for this function:

getCurrentSortation()

ilUserCertificateGUI::getCurrentSortation ( )

protected

Definition at line 293 of file class.ilUserCertificateGUI.php.

                                            : string
    {
        $sorting = ilSession::get(self::SORTATION_SESSION_KEY);
        if (!array_key_exists($sorting, $this->sortationOptions)) {
            $sorting = $this->defaultSorting;
        }
 
        return $sorting;
    }

References $defaultSorting, and ilSession\get().

Referenced by listCertificates().

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultCommand()

ilUserCertificateGUI::getDefaultCommand ( )

private

Definition at line 136 of file class.ilUserCertificateGUI.php.

                                        : string
    {
        return 'listCertificates';
    }

Referenced by executeCommand().

Here is the caller graph for this function:

listCertificates()

ilUserCertificateGUI::listCertificates

(

)

Exceptions

ilDateTimeException
ilWACException

Definition at line 167 of file class.ilUserCertificateGUI.php.

                                      : void
    {
        global $DIC;
 
        if (!$this->certificateSettings->get('active', '0')) {
            $this->ctrl->redirect($this);
        }
 
        $provider = new ilUserCertificateTableProvider(
            $DIC->database(),
            $this->certificateLogger,
            $this->language->txt('certificate_no_object_title')
        );
 
        $sorting = $this->getCurrentSortation();
        $data = $provider->fetchDataSet(
            $this->user->getId(),
            [
                'order_field' => explode('_', $sorting)[0],
                'order_direction' => explode('_', $sorting)[1],
                'language' => $this->user->getLanguage()
            ],
            []
        );
 
        $uiComponents = [];
 
        if (count($data['items']) > 0) {
            $sortationOptions = [];
            $cards = [];
 
            foreach ($this->sortationOptions as $fieldAndDirection => $lngVariable) {
                $sortationOptions[$fieldAndDirection] = $this->language->txt($lngVariable);
            }
 
            $sortViewControl = $this->uiFactory
                ->viewControl()
                ->sortation($sortationOptions)
                ->withLabel($this->language->txt($this->sortationOptions[$sorting]))
                ->withTargetURL($this->ctrl->getLinkTarget($this, 'applySortation'), 'sort_by');
            $uiComponents[] = $sortViewControl;
 
            foreach ($data['items'] as $certificateData) {
                $thumbnailImagePath = $certificateData['thumbnail_image_path'];
                $imagePath = ilFileUtils::getWebspaceDir() . $thumbnailImagePath;
                if ($thumbnailImagePath === null
                    || $thumbnailImagePath === ''
                    || !$this->filesystem->has($thumbnailImagePath)
                ) {
                    $imagePath = ilUtil::getImagePath('icon_cert.svg');
                }
 
                $cardImage = $this->uiFactory->image()->standard(
                    ilWACSignedPath::signFile($imagePath),
                    $certificateData['title']
                );
 
                $sections = [];
 
                if ($certificateData['description'] !== '') {
                    $sections[] = $this->uiFactory->listing()->descriptive([
                        $this->language->txt('cert_description_label') => $certificateData['description']
                    ]);
                }
 
                $oldDatePresentationStatus = ilDatePresentation::useRelativeDates();
                ilDatePresentation::setUseRelativeDates(true);
                $sections[] = $this->uiFactory->listing()->descriptive([
                    $this->language->txt('cert_issued_on_label') => ilDatePresentation::formatDate(
                        new ilDateTime($certificateData['date'], IL_CAL_UNIX)
                    )
                ]);
                ilDatePresentation::setUseRelativeDates($oldDatePresentationStatus);
 
                $objectTypeIcon = $this->uiFactory
                    ->symbol()
                    ->icon()
                    ->standard($certificateData['obj_type'], $certificateData['obj_type']);
 
                $objectTitle = $certificateData['title'];
                $refIds = ilObject::_getAllReferences((int) $certificateData['obj_id']);
                if (count($refIds) > 0) {
                    foreach ($refIds as $refId) {
                        if ($this->access->checkAccess('read', '', $refId)) {
                            $objectTitle = $this->uiRenderer->render(
                                $this->uiFactory->link()->standard($objectTitle, ilLink::_getLink($refId))
                            );
                            break;
                        }
                    }
                }
 
                $sections[] = $this->uiFactory->listing()->descriptive([$this->language->txt('cert_object_label') => implode(
                    '',
                    [
                        $this->uiRenderer->render($objectTypeIcon),
                        $objectTitle
                    ]
                )
                ]);
 
                $this->ctrl->setParameter($this, 'certificate_id', $certificateData['id']);
                $downloadHref = $this->ctrl->getLinkTarget($this, 'download');
                $this->ctrl->clearParameters($this);
                $sections[] = $this->uiFactory->button()->standard('Download', $downloadHref);
 
                $card = $this->uiFactory
                    ->card()
                    ->standard($certificateData['title'], $cardImage)
                    ->withSections($sections);
 
                $cards[] = $card;
            }
 
            $deck = $this->uiFactory->deck($cards)->withSmallCardsSize();
 
            $uiComponents[] = $this->uiFactory->divider()->horizontal();
 
            $uiComponents[] = $deck;
        } else {
            $this->template->setOnScreenMessage('info', $this->language->txt('cert_currently_no_certs'));
        }
 
        $this->template->setContent($this->uiRenderer->render($uiComponents));
    }

References $data, $DIC, $provider, $refId, $sortationOptions, ilObject\_getAllReferences(), ilLink\_getLink(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\filesystem(), ilDatePresentation\formatDate(), getCurrentSortation(), ilUtil\getImagePath(), ilFileUtils\getWebspaceDir(), IL_CAL_UNIX, ILIAS\UI\examples\Symbol\Glyph\Language\language(), ilDatePresentation\setUseRelativeDates(), ilWACSignedPath\signFile(), ILIAS\Repository\user(), and ilDatePresentation\useRelativeDates().

Referenced by applySortation(), and download().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access

ilAccessHandler ilUserCertificateGUI::$access

protected

Definition at line 43 of file class.ilUserCertificateGUI.php.

Referenced by __construct().

$certificateLogger

ilLogger ilUserCertificateGUI::$certificateLogger

private

Definition at line 39 of file class.ilUserCertificateGUI.php.

Referenced by __construct().

$certificateSettings

ilSetting ilUserCertificateGUI::$certificateSettings

protected

Definition at line 40 of file class.ilUserCertificateGUI.php.

Referenced by __construct().

$ctrl

ilCtrlInterface ilUserCertificateGUI::$ctrl

private

Definition at line 34 of file class.ilUserCertificateGUI.php.

Referenced by __construct().

$defaultSorting

string ilUserCertificateGUI::$defaultSorting = 'date_DESC'

protected

Definition at line 51 of file class.ilUserCertificateGUI.php.

Referenced by applySortation(), and getCurrentSortation().

$filesystem

Filesystem ilUserCertificateGUI::$filesystem

private

Definition at line 52 of file class.ilUserCertificateGUI.php.

Referenced by __construct().

$language

ilLanguage ilUserCertificateGUI::$language

private

Definition at line 35 of file class.ilUserCertificateGUI.php.

Referenced by __construct(), and download().

$request

ServerRequestInterface ilUserCertificateGUI::$request

private

Definition at line 38 of file class.ilUserCertificateGUI.php.

Referenced by __construct().

$sortationOptions

array ilUserCertificateGUI::$sortationOptions

protected

Initial value:

= [
        'title_ASC' => 'cert_sortable_by_title_asc',
        'title_DESC' => 'cert_sortable_by_title_desc',
        'date_ASC' => 'cert_sortable_by_issue_date_asc',
        'date_DESC' => 'cert_sortable_by_issue_date_desc',
    ]

Definition at line 45 of file class.ilUserCertificateGUI.php.

Referenced by listCertificates().

$template

ilGlobalTemplateInterface ilUserCertificateGUI::$template

private

Definition at line 33 of file class.ilUserCertificateGUI.php.

Referenced by __construct().

$uiFactory

Factory ilUserCertificateGUI::$uiFactory

protected

Definition at line 41 of file class.ilUserCertificateGUI.php.

Referenced by __construct().

$uiRenderer

Renderer ilUserCertificateGUI::$uiRenderer

protected

Definition at line 42 of file class.ilUserCertificateGUI.php.

Referenced by __construct().

$user

ilObjUser ilUserCertificateGUI::$user

private

Definition at line 37 of file class.ilUserCertificateGUI.php.

Referenced by __construct(), and download().

$userCertificateRepository

ilUserCertificateRepository ilUserCertificateGUI::$userCertificateRepository

private

Definition at line 36 of file class.ilUserCertificateGUI.php.

Referenced by __construct().

SORTATION_SESSION_KEY

const ilUserCertificateGUI::SORTATION_SESSION_KEY = 'my_certificates_sorting'

Definition at line 44 of file class.ilUserCertificateGUI.php.

---

The documentation for this class was generated from the following file:

• Services/Certificate/classes/User/class.ilUserCertificateGUI.php