Collaboration diagram for ilUserCertificateGUI:

Public Member Functions
	__construct (ilTemplate $template=null, ilCtrl $controller=null, ilLanguage $language=null, ilObjUser $user=null, ilUserCertificateRepository $userCertificateRepository=null, GuzzleHttp\Psr7\Request $request=null, ilLogger $certificateLogger=null, ilSetting $certificateSettings=null, Factory $uiFactory=null, Renderer $uiRenderer=null, \ilAccessHandler $access=null, \ILIAS\Filesystem\Filesystem $filesystem=null, ilCertificateMigrationValidator $migrationVisibleValidator=null)

	executeCommand ()

	listCertificates (bool $migrationWasStarted=false)

	download ()

Data Fields
const	SORTATION_SESSION_KEY = 'my_certificates_sorting'

Protected Member Functions
	getCurrentSortation ()

	applySortation ()

Protected Attributes
	$certificateSettings

	$uiFactory

	$uiRenderer

	$access

	$sortationOptions

	$defaultSorting = 'date_DESC'

Private Member Functions
	getDefaultCommand ()

Private Attributes
	$template

	$controller

	$language

	$userCertificateRepository

	$user

	$request

	$certificateLogger

	$filesystem

	$migrationVisibleValidator

Detailed Description

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

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

Constructor & Destructor Documentation

◆ __construct()

ilUserCertificateGUI::__construct	(	ilTemplate	$template = `null`,
		ilCtrl	$controller = `null`,
		ilLanguage	$language = `null`,
		ilObjUser	$user = `null`,
		ilUserCertificateRepository	$userCertificateRepository = `null`,
		GuzzleHttp\Psr7\Request	$request = `null`,
		ilLogger	$certificateLogger = `null`,
		ilSetting	$certificateSettings = `null`,
		Factory	$uiFactory = `null`,
		Renderer	$uiRenderer = `null`,
		\ilAccessHandler	$access = `null`,
		\ILIAS\Filesystem\Filesystem	$filesystem = `null`,
		ilCertificateMigrationValidator	$migrationVisibleValidator = `null`
	)

Parameters

ilTemplate \| null	$template
ilCtrl \| null	$controller
ilLanguage \| null	$language
ilObjUser	$user
ilUserCertificateRepository \| null	$userCertificateRepository
\GuzzleHttp\Psr7\Request \| null	$request
ilLogger	$certificateLogger
ilSetting \| null	$certificateSettings
Factory \| null	$uiFactory
Renderer \| null	$uiRenderer
\ilAccessHandler \| null	$access
\ILIAS\Filesystem\Filesystem \| null	$filesystem
ilCertificateMigrationValidator \| null	$migrationVisibleValidator

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

References $access, $certificateLogger, $certificateSettings, $controller, $DIC, $filesystem, $language, $migrationVisibleValidator, $request, $template, $uiFactory, $uiRenderer, $user, $userCertificateRepository, and user().

       {
         global $DIC;
 
         $logger = $DIC->logger()->cert();
 
         if ($template === null) {
             $template = $DIC->ui()->mainTemplate();
         }
         $this->template = $template;
 
         if ($controller === null) {
             $controller = $DIC->ctrl();
         }
         $this->controller = $controller;
         
         if ($language === null) {
             $language = $DIC->language();
         }
         $this->language = $language;
 
         if ($userCertificateRepository === null) {
             $userCertificateRepository = new ilUserCertificateRepository($DIC->database(), $logger);
         }
         $this->userCertificateRepository = $userCertificateRepository;
 
         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 (null === $migrationVisibleValidator) {
             $migrationVisibleValidator = new ilCertificateMigrationValidator($this->certificateSettings);
         }
         $this->migrationVisibleValidator = $migrationVisibleValidator;
 
         $this->language->loadLanguageModule('cert');
     }

Here is the call graph for this function:

Member Function Documentation

◆ applySortation()

ilUserCertificateGUI::applySortation ( )

protected

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

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

     {
         $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

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

References $DIC, $language, $user, $userCertificateRepository, ilCertificatePdfAction\downloadPdf(), listCertificates(), and ilUtil\sendFailure().

     {
         global $DIC;
 
         $user = $DIC->user();
         $language = $DIC->language();
 
         $userCertificateRepository = new ilUserCertificateRepository(null, $this->certificateLogger);
         $pdfGenerator = new ilPdfGenerator($userCertificateRepository, $this->certificateLogger);
 
         $userCertificateId = (int) $this->request->getQueryParams()['certificate_id'];
 
         try {
             $userCertificate = $userCertificateRepository->fetchCertificate($userCertificateId);
             if ((int) $userCertificate->getUserId() !== (int) $user->getId()) {
                 throw new ilException(sprintf('User "%s" tried to access certificate: "%s"', $user->getLogin(), $userCertificateId));
             }
         } catch (ilException $exception) {
             $this->certificateLogger->warning($exception->getMessage());
             ilUtil::sendFailure($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();
     }

Here is the call graph for this function:

◆ executeCommand()

ilUserCertificateGUI::executeCommand ( )

Returns: bool

Exceptions

ilDateTimeException
ilException

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

References getDefaultCommand(), listCertificates(), and ilTemplate\MESSAGE_TYPE_SUCCESS.

     {
         $nextClass = $this->controller->getNextClass($this);
         $cmd = $this->controller->getCmd();
 
         if (!$this->certificateSettings->get('active')) {
             $this->controller->returnToParent($this);
         }
         
         $this->template->setTitle($this->language->txt('obj_cert'));
 
         switch ($nextClass) {
             case 'ilcertificatemigrationgui':
                 $migrationGui = new \ilCertificateMigrationGUI();
                 $resultMessageString = $this->controller->forwardCommand($migrationGui);
                 $this->template->setMessage(\ilTemplate::MESSAGE_TYPE_SUCCESS, $resultMessageString, true);
                 $this->listCertificates(true);
                 break;
 
             default:
                 if (!method_exists($this, $cmd)) {
                     $cmd = $this->getDefaultCommand();
                 }
                 $this->{$cmd}();
         }
 
         return true;
     }

Here is the call graph for this function:

◆ getCurrentSortation()

ilUserCertificateGUI::getCurrentSortation ( )

protected

Returns: string

Definition at line 368 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

Returns: string

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

Referenced by executeCommand().

                                          : string
     {
         return 'listCertificates';
     }

Here is the caller graph for this function:

◆ listCertificates()

ilUserCertificateGUI::listCertificates ( bool $migrationWasStarted = false )

Parameters

bool $migrationWasStarted

Exceptions

ilDateTimeException
ilWACException

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

References $certificateLogger, $controller, $data, $DIC, PHPMailer\PHPMailer\$provider, $sortationOptions, ilObject\_getAllReferences(), ilLink\_getLink(), ilDatePresentation\formatDate(), getCurrentSortation(), ilUtil\getImagePath(), ilUtil\getWebspaceDir(), IL_CAL_UNIX, ilUtil\sendInfo(), ilDatePresentation\setUseRelativeDates(), ilWACSignedPath\signFile(), user(), and ilDatePresentation\useRelativeDates().

Referenced by applySortation(), download(), and executeCommand().

     {
         global $DIC;
 
         if (!$this->certificateSettings->get('active')) {
             $this->controller->redirect($this);
             return;
         }
 
         $this->template->setBodyClass('iosMyCertificates');
 
         $showMigrationBox = $this->migrationVisibleValidator->isMigrationAvailable(
             $this->user,
             new \ilCertificateMigration($this->user->getId())
         );
         if (!$migrationWasStarted && true === $showMigrationBox) {
             $migrationUiEl = new \ilCertificateMigrationUIElements();
             $startMigrationCommand = $this->controller->getLinkTargetByClass(
                 ['ilCertificateMigrationGUI'],
                 'startMigrationAndReturnMessage',
                 false,
                 true,
                 false
             );
             $messageBoxHtml = $migrationUiEl->getMigrationMessageBox($startMigrationCommand);
 
             $this->template->setCurrentBlock('mess');
             $this->template->setVariable('MESSAGE', $messageBoxHtml);
             $this->template->parseCurrentBlock('mess');
         }
 
         $provider = new ilUserCertificateTableProvider(
             $DIC->database(),
             $this->certificateLogger,
             $this->controller,
             $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]
             ],
             []
         );
 
         $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->controller->getLinkTarget($this, 'applySortation'), 'sort_by');
             $uiComponents[] = $sortViewControl;
 
             foreach ($data['items'] as $certificateData) {
                 $thumbnailImagePath = $certificateData['thumbnail_image_path'];
                 $imagePath = ilUtil::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 (strlen($certificateData['description']) > 0) {
                     $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
                     ->icon()
                     ->standard($certificateData['obj_type'], $certificateData['obj_type'], 'small');
 
                 $objectTitle = $certificateData['title'];
                 $refIds = \ilObject::_getAllReferences($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->controller->setParameter($this, 'certificate_id', $certificateData['id']);
                 $downloadHref = $this->controller->getLinkTarget($this, 'download');
                 $this->controller->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);
 
             $uiComponents[] = $this->uiFactory->divider()->horizontal();
 
             $uiComponents[] = $deck;
         } else {
             \ilUtil::sendInfo($this->language->txt('cert_currently_no_certs'));
         }
 
         $this->template->setContent($this->uiRenderer->render($uiComponents));
     }