ilUserCertificateGUI Class Reference

@ilCtrl_IsCalledBy ilUserCertificateGUI: ilAchievementsGUI More...

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, private readonly ilSetting $certificateSettings=new ilSetting('certificate'), ?Factory $uiFactory=null, ?Renderer $uiRenderer=null, ?ilAccessHandler $access=null, ?ilHelpGUI $help=null, ?ilDBInterface $db=null, private ?IRSS $irss=null)
	executeCommand ()
	listCertificates ()
	download ()

Data Fields
final const string	SORTATION_SESSION_KEY = 'my_certificates_sorting'

Protected Member Functions
	getCurrentSortation ()
	applySortation ()

Protected Attributes
array	$sortation_options
string	$default_sorting = 'date_DESC'

Private Member Functions
	getDefaultCommand ()

Private Attributes
readonly ilGlobalTemplateInterface	$template
readonly ilCtrlInterface	$ctrl
readonly ilLanguage	$language
readonly ilUserCertificateRepository	$user_certificate_repo
readonly ilObjUser	$user
readonly ServerRequestInterface	$request
readonly ilLogger	$logger
readonly Factory	$ui_factory
readonly Renderer	$ui_renderer
readonly ilAccessHandler	$access
readonly ilHelpGUI	$help
readonly ilDBInterface	$db

Detailed Description

@ilCtrl_IsCalledBy ilUserCertificateGUI: ilAchievementsGUI

Definition at line 30 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,
		private readonly ilSetting	$certificateSettings = new ilSetting('certificate'),
		?Factory	$uiFactory = null,
		?Renderer	$uiRenderer = null,
		?ilAccessHandler	$access = null,
		?ilHelpGUI	$help = null,
		?ilDBInterface	$db = null,
		private ?IRSS	$irss = null
	)

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

      {
        global $DIC;
 
        $this->template = $template ?? $DIC->ui()->mainTemplate();
        $this->ctrl = $ctrl ?? $DIC->ctrl();
        $this->user = $user ?? $DIC->user();
        $this->language = $language ?? $DIC->language();
        $this->request = $request ?? $DIC->http()->request();
        $this->logger = $certificateLogger ?? $DIC->logger()->cert();
        $this->ui_factory = $uiFactory ?? $DIC->ui()->factory();
        $this->ui_renderer = $uiRenderer ?? $DIC->ui()->renderer();
        $this->access = $access ?? $DIC->access();
        $this->user_certificate_repo = $userCertificateRepository ?? new ilUserCertificateRepository(null, $this->logger);
        $this->help = $help ?? $DIC->help();
        $this->db = $db ?? $DIC->database();
        $this->irss = $irss ?? $DIC->resourceStorage();
 
        $this->language->loadLanguageModule('cert');
    }

References $db, $DIC, $request, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\help(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), ILIAS\Repository\logger(), 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 264 of file class.ilUserCertificateGUI.php.

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

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

Here is the call graph for this function:

download()

ilUserCertificateGUI::download

(

)

Exceptions

ilException

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

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

References ILIAS\Repository\int(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), listCertificates(), ILIAS\Repository\logger(), and ILIAS\Repository\user().

Here is the call graph for this function:

executeCommand()

ilUserCertificateGUI::executeCommand

(

)

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

                                    : bool
    {
        $cmd = $this->ctrl->getCmd();
 
        if (!$this->certificateSettings->get('active', '0')) {
            $this->ctrl->returnToParent($this);
        }
 
        $this->template->setTitle($this->language->txt('obj_cert'));
        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 250 of file class.ilUserCertificateGUI.php.

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

References $default_sorting, 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 93 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 119 of file class.ilUserCertificateGUI.php.

                                      : void
    {
        $this->help->setScreenIdComponent('cert');
 
        if (!$this->certificateSettings->get('active', '0')) {
            $this->ctrl->redirect($this);
        }
 
        $this->template->setPermanentLink('cert', null, 'list');
 
        $provider = new ilUserCertificateTableProvider(
            $this->db,
            $this->logger,
            $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 ($data['items'] !== []) {
            $sortationOptions = [];
            $cards = [];
 
            foreach ($this->sortation_options as $fieldAndDirection => $lngVariable) {
                $sortationOptions[$fieldAndDirection] = $this->language->txt($lngVariable);
            }
 
            $sortViewControl = $this->ui_factory
                ->viewControl()
                ->sortation($sortationOptions, $sorting)
                ->withTargetURL($this->ctrl->getLinkTarget($this, 'applySortation'), 'sort_by');
 
            $uiComponents[] = $sortViewControl;
 
            foreach ($data['items'] as $certificateData) {
                $tile_image_identification = $certificateData['tile_image_ident'] ?? '';
                $imagePath = '';
                $tile_image_rid = $this->irss->manage()->find($tile_image_identification);
                if ($tile_image_rid instanceof ResourceIdentification) {
                    $imagePath = $this->irss->consume()->src($tile_image_rid)->getSrc(true);
                }
 
                if ($imagePath === '') {
                    $imagePath = ilUtil::getImagePath('standard/icon_cert.svg');
                }
 
                $cardImage = $this->ui_factory->image()->standard(
                    $imagePath,
                    $certificateData['title']
                );
 
                $sections = [];
 
                if ($certificateData['description'] !== '') {
                    $sections[] = $this->ui_factory->listing()->descriptive([
                        $this->language->txt('cert_description_label') => $certificateData['description']
                    ]);
                }
 
                $oldDatePresentationStatus = ilDatePresentation::useRelativeDates();
                ilDatePresentation::setUseRelativeDates(true);
                $sections[] = $this->ui_factory->listing()->descriptive([
                    $this->language->txt('cert_issued_on_label') => ilDatePresentation::formatDate(
                        new ilDateTime($certificateData['date'], IL_CAL_UNIX)
                    )
                ]);
                ilDatePresentation::setUseRelativeDates($oldDatePresentationStatus);
 
                $objectTypeIcon = $this->ui_factory
                    ->symbol()
                    ->icon()
                    ->standard($certificateData['obj_type'], $certificateData['obj_type'])
                ;
 
                $objectTitle = $certificateData['title'];
                $refIds = ilObject::_getAllReferences((int) $certificateData['obj_id']);
                foreach ($refIds as $refId) {
                    if ($this->access->checkAccess('read', '', $refId)) {
                        $objectTitle = $this->ui_renderer->render(
                            $this->ui_factory->link()->standard($objectTitle, ilLink::_getLink($refId))
                        );
 
                        break;
                    }
                }
 
                $sections[] = $this->ui_factory->listing()->descriptive([$this->language->txt('cert_object_label') => implode(
                    '',
                    [
                        $this->ui_renderer->render($objectTypeIcon),
                        $objectTitle
                    ]
                )
                ]);
 
                $this->ctrl->setParameter($this, 'certificate_id', $certificateData['id']);
                $downloadHref = $this->ctrl->getLinkTarget($this, 'download');
                $this->ctrl->clearParameters($this);
                $sections[] = $this->ui_factory->button()->standard('Download', $downloadHref);
 
                $card = $this->ui_factory
                    ->card()
                    ->standard($certificateData['title'], $cardImage)
                    ->withSections($sections)
                ;
 
                $cards[] = $card;
            }
 
            $deck = $this->ui_factory->deck($cards)->withSmallCardsSize();
 
            $uiComponents[] = $this->ui_factory->divider()->horizontal();
 
            $uiComponents[] = $deck;
        } else {
            $this->template->setOnScreenMessage('info', $this->language->txt('cert_currently_no_certs'));
        }
 
        $this->template->setContent($this->ui_renderer->render($uiComponents));
    }

References $data, $provider, $refId, ilObject\_getAllReferences(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilDatePresentation\formatDate(), getCurrentSortation(), ilUtil\getImagePath(), ILIAS\Repository\help(), IL_CAL_UNIX, ILIAS\UI\examples\Symbol\Glyph\Language\language(), ILIAS\Repository\logger(), ilDatePresentation\setUseRelativeDates(), 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

readonly ilAccessHandler ilUserCertificateGUI::$access

private

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

$ctrl

readonly ilCtrlInterface ilUserCertificateGUI::$ctrl

private

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

$db

readonly ilDBInterface ilUserCertificateGUI::$db

private

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

Referenced by __construct().

$default_sorting

string ilUserCertificateGUI::$default_sorting = 'date_DESC'

protected

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

Referenced by applySortation(), and getCurrentSortation().

$help

readonly ilHelpGUI ilUserCertificateGUI::$help

private

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

$language

readonly ilLanguage ilUserCertificateGUI::$language

private

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

$logger

readonly ilLogger ilUserCertificateGUI::$logger

private

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

$request

readonly ServerRequestInterface ilUserCertificateGUI::$request

private

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

Referenced by __construct().

$sortation_options

array ilUserCertificateGUI::$sortation_options

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 50 of file class.ilUserCertificateGUI.php.

$template

readonly ilGlobalTemplateInterface ilUserCertificateGUI::$template

private

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

$ui_factory

readonly Factory ilUserCertificateGUI::$ui_factory

private

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

$ui_renderer

readonly Renderer ilUserCertificateGUI::$ui_renderer

private

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

$user

readonly ilObjUser ilUserCertificateGUI::$user

private

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

$user_certificate_repo

readonly ilUserCertificateRepository ilUserCertificateGUI::$user_certificate_repo

private

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

SORTATION_SESSION_KEY

final const string ilUserCertificateGUI::SORTATION_SESSION_KEY = 'my_certificates_sorting'

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

---

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

• components/ILIAS/Certificate/classes/User/class.ilUserCertificateGUI.php