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, ?Filesystem $filesystem=null, ?ilHelpGUI $help=null, ?ilDBInterface $db=null, private ?IRSS $irss=null)

	executeCommand ()

	listCertificates ()

	download ()

Data Fields
final const	SORTATION_SESSION_KEY = 'my_certificates_sorting'

Protected Member Functions
	getCurrentSortation ()

	applySortation ()

Protected Attributes
array	$sortationOptions

array string	$defaultSorting = 'date_DESC'

Private Member Functions
	getDefaultCommand ()

Private Attributes
readonly ilGlobalTemplateInterface	$template

readonly ilCtrlInterface	$ctrl

readonly ilLanguage	$language

readonly ilUserCertificateRepository	$userCertificateRepository

readonly ilObjUser	$user

readonly ServerRequestInterface	$request

readonly ilLogger	$certificateLogger

readonly Factory	$uiFactory

readonly Renderer	$uiRenderer

readonly ilAccessHandler	$access

readonly ilHelpGUI	$help

readonly ilDBInterface	$db

readonly Filesystem	$filesystem

Detailed Description

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

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

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\filesystem(), ILIAS\Repository\help(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\Repository\user().

       {
         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->certificateLogger = $certificateLogger ?? $DIC->logger()->cert();
         $this->uiFactory = $uiFactory ?? $DIC->ui()->factory();
         $this->uiRenderer = $uiRenderer ?? $DIC->ui()->renderer();
         $this->access = $access ?? $DIC->access();
         $this->filesystem = $filesystem ?? $DIC->filesystem()->web();
         $this->userCertificateRepository = $userCertificateRepository ?? new ilUserCertificateRepository(null, $this->certificateLogger);
         $this->help = $help ?? $DIC->help();
         $this->db = $db ?? $DIC->database();
         $this->irss = $irss ?? $DIC->resourceStorage();
 
         $this->language->loadLanguageModule('cert');
     }

Here is the call graph for this function:

Member Function Documentation

◆ applySortation()

ilUserCertificateGUI::applySortation ( )

protected

Exceptions

ilWACException
ilDateTimeException

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

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

                                        : 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();
     }

Here is the call graph for this function:

◆ download()

ilUserCertificateGUI::download ( )

Exceptions

ilException

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

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

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

Here is the call graph for this function:

◆ executeCommand()

ilUserCertificateGUI::executeCommand ( )

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

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

                                     : 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;
     }

Here is the call graph for this function:

◆ getCurrentSortation()

ilUserCertificateGUI::getCurrentSortation ( )

protected

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

References $defaultSorting, and ilSession\get().

Referenced by listCertificates().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultCommand()

ilUserCertificateGUI::getDefaultCommand ( )

private

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

Referenced by executeCommand().

                                         : string
     {
         return 'listCertificates';
     }

Here is the caller graph for this function:

◆ listCertificates()

ilUserCertificateGUI::listCertificates ( )

Exceptions

ilDateTimeException
ilWACException

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

References $data, $provider, $refId, ilObject\_getAllReferences(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\filesystem(), ilDatePresentation\formatDate(), getCurrentSortation(), ilUtil\getImagePath(), ilFileUtils\getWebspaceDir(), ILIAS\Repository\help(), 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().

                                       : void
     {
         $this->help->setScreenIdComponent('cert');
 
         if (!$this->certificateSettings->get('active', '0')) {
             $this->ctrl->redirect($this);
         }
 
         $provider = new ilUserCertificateTableProvider(
             $this->db,
             $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 ($data['items'] !== []) {
             $sortationOptions = [];
             $cards = [];
 
             foreach ($this->sortationOptions as $fieldAndDirection => $lngVariable) {
                 $sortationOptions[$fieldAndDirection] = $this->language->txt($lngVariable);
             }
 
             $sortViewControl = $this->uiFactory
                 ->viewControl()
                 ->sortation($sortationOptions, $sorting)
                 ->withTargetURL($this->ctrl->getLinkTarget($this, 'applySortation'), 'sort_by');
 
             $uiComponents[] = $sortViewControl;
 
             foreach ($data['items'] as $certificateData) {
                 $thumbnail_image_identification = $certificateData['thumbnail_image_ident'] ?? '';
                 $imagePath = '';
                 if ($thumbnail_image_identification === '' || $thumbnail_image_identification === '-') {
                     $thumbnail_image_identification = $certificateData['thumbnail_image_path'] ?? '';
                     if ($thumbnail_image_identification !== '' && $this->filesystem->has($thumbnail_image_identification)) {
                         $imagePath = ilWACSignedPath::signFile(
                             ilFileUtils::getWebspaceDir() . $thumbnail_image_identification
                         );
                     }
                 } else {
                     $thumb_rid = $this->irss->manage()->find($thumbnail_image_identification);
                     if ($thumb_rid instanceof ResourceIdentification) {
                         $imagePath = $this->irss->consume()->src($thumb_rid)->getSrc(true);
                     }
                 }
 
                 if ($imagePath === '') {
                     $imagePath = ilUtil::getImagePath('standard/icon_cert.svg');
                 }
 
                 $cardImage = $this->uiFactory->image()->standard(
                     $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']);
                 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));
     }