GUI class to create PDF certificates. More...

Collaboration diagram for ilCertificateGUI:

Public Member Functions
	__construct (private readonly ilCertificatePlaceholderDescription $placeholderDescriptionObject, ilCertificatePlaceholderValues $placeholderValuesObject, private readonly int $objectId, string $certificatePath, ?ilCertificateFormRepository $settingsFormFactory=null, ?ilCertificateDeleteAction $deleteAction=null, ?ilCertificateTemplateRepository $templateRepository=null, ?ilPageFormats $pageFormats=null, ?ilXlsFoParser $xlsFoParser=null, ?ilCertificateTemplateExportAction $exportAction=null, ?ilCertificateTemplatePreviewAction $previewAction=null, ?FileUpload $fileUpload=null, private readonly ilSetting $settings=new ilSetting('certificate'), ?Filesystem $tmp_file_system=null)

	executeCommand ()

	getCommand ($cmd)

	certificateImport ()

	certificatePreview ()

	certificateExportFO ()
	Exports the certificate. More...

	certificateDelete ()

	certificateDeleteConfirm ()
	Deletes the certificate and all its data. More...

	certificateSave ()
	Saves the certificate. More...

	certificateUpload ()

Data Fields
const string	EDITOR_COMMAND = 'certificateEditor'

Protected Attributes
ilCtrlInterface	$ctrl

ilTree	$tree

ILIAS	$ilias

ilGlobalPageTemplate	$tpl

ilLanguage	$lng

int	$ref_id

ilAccessHandler	$access

ilToolbarGUI	$toolbar

Private Member Functions
	getEditorForm ()

	saveCertificate (ilPropertyFormGUI $form, array $form_fields, int $objId)

	createFormatArray (ilCertificateTemplate $certificateTemplate)

Private Attributes
readonly WrapperFactory	$httpWrapper

readonly Factory	$refinery

IRSS	$irss

ilCertificateTemplateStakeholder	$stakeholder

ilCertificateTemplateDatabaseRepository	$certificate_repo

readonly ilCertificateTemplateRepository	$templateRepository

readonly ilCertificateFormRepository	$settingsFormFactory

readonly ilXlsFoParser	$xlsFoParser

readonly ilCertificateDeleteAction	$deleteAction

readonly ilCertificateTemplateExportAction	$exportAction

readonly ilCertificateTemplatePreviewAction	$previewAction

readonly FileUpload	$fileUpload

readonly string	$certificatePath

readonly ilPageFormats	$pageFormats

readonly ilLogger	$logger

readonly ilObjCertificateSettings	$global_certificate_settings

readonly ilDBInterface	$database

Detailed Description

GUI class to create PDF certificates.

Author: Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m

Version: $Id$ / @ilCtrl_Calls ilCertificateGUI: ilPropertyFormGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilCertificateGUI::__construct	(	private readonly ilCertificatePlaceholderDescription	$placeholderDescriptionObject,
		ilCertificatePlaceholderValues	$placeholderValuesObject,
		private readonly int	$objectId,
		string	$certificatePath,
		?ilCertificateFormRepository	$settingsFormFactory = `null`,
		?ilCertificateDeleteAction	$deleteAction = `null`,
		?ilCertificateTemplateRepository	$templateRepository = `null`,
		?ilPageFormats	$pageFormats = `null`,
		?ilXlsFoParser	$xlsFoParser = `null`,
		?ilCertificateTemplateExportAction	$exportAction = `null`,
		?ilCertificateTemplatePreviewAction	$previewAction = `null`,
		?FileUpload	$fileUpload = `null`,
		private readonly ilSetting	$settings = `new ilSetting('certificate')`,
		?Filesystem	$tmp_file_system = `null`
	)

Definition at line 70 of file class.ilCertificateGUI.php.

      {
        global $DIC;
 
        $this->httpWrapper = $DIC->http()->wrapper();
        $this->refinery = $DIC->refinery();
        $this->lng = $DIC['lng'];
        $this->tpl = $DIC['tpl'];
        $this->ctrl = $DIC['ilCtrl'];
        $this->ilias = $DIC['ilias'];
 
        $this->irss = $DIC->resourceStorage();
        $this->stakeholder = new ilCertificateTemplateStakeholder($this->objectId);
 
        $this->tree = $DIC['tree'];
        $this->access = $DIC['ilAccess'];
        $this->toolbar = $DIC['ilToolbar'];
 
        $this->global_certificate_settings = new ilObjCertificateSettings();
        $this->lng->loadLanguageModule('certificate');
        $this->lng->loadLanguageModule('cert');
        $this->lng->loadLanguageModule('trac');
 
        $this->ref_id = (int) $DIC->http()->wrapper()->query()->retrieve('ref_id', $DIC->refinery()->kindlyTo()->int());
 
        $this->logger = $DIC->logger()->cert();
 
        $this->settingsFormFactory = $settingsFormFactory ?? new ilCertificateSettingsFormRepository(
            $this->objectId,
            $certificatePath,
            $this->lng,
            $this->tpl,
            $this->ctrl,
            $this->access,
            $this->toolbar,
            $placeholderDescriptionObject,
            $DIC->ui()->factory(),
            $DIC->ui()->renderer()
        );
        $this->templateRepository = $templateRepository ?? new ilCertificateTemplateDatabaseRepository(
            $DIC->database(),
            $this->logger
        );
        $this->deleteAction = $deleteAction ?? new ilCertificateTemplateDeleteAction($this->templateRepository);
        $this->pageFormats = $pageFormats ?? new ilPageFormats($DIC->language());
        $this->xlsFoParser = $xlsFoParser ?? new ilXlsFoParser($DIC->settings(), $this->pageFormats);
        $this->exportAction = $exportAction ?? new ilCertificateTemplateExportAction(
            $this->objectId,
            $certificatePath,
            $this->templateRepository,
            $this->irss
        );
        $this->previewAction = $previewAction ?? new ilCertificateTemplatePreviewAction(
            $this->templateRepository,
            $placeholderValuesObject,
            $this->irss
        );
        $this->fileUpload = $fileUpload ?? $DIC->upload();
        $this->database = $DIC->database();
    }

References $certificatePath, $deleteAction, $DIC, $exportAction, $fileUpload, $pageFormats, $previewAction, $settingsFormFactory, $templateRepository, $xlsFoParser, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\database(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), ILIAS\Repository\refinery(), and ILIAS\Repository\toolbar().

Here is the call graph for this function:

Member Function Documentation

◆ certificateDelete()

ilCertificateGUI::certificateDelete ( )

Definition at line 209 of file class.ilCertificateGUI.php.

                                       : void
    {
        // display confirmation message
        $cgui = new ilConfirmationGUI();
        $cgui->setFormAction($this->ctrl->getFormAction($this, self::EDITOR_COMMAND));
        $cgui->setHeaderText($this->lng->txt('certificate_confirm_deletion_text'));
        $cgui->setCancel($this->lng->txt('no'), self::EDITOR_COMMAND);
        $cgui->setConfirm($this->lng->txt('yes'), 'certificateDeleteConfirm');
 
        $this->tpl->setContent($cgui->getHTML());
    }

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ certificateDeleteConfirm()

ilCertificateGUI::certificateDeleteConfirm ( )

Deletes the certificate and all its data.

Definition at line 224 of file class.ilCertificateGUI.php.

                                              : void
    {
        $template = $this->templateRepository->fetchCurrentlyUsedCertificate($this->objectId);
        $templateId = $template->getId();
 
        $this->deleteAction->delete($templateId, $this->objectId);
        $this->ctrl->redirect($this, self::EDITOR_COMMAND);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ certificateExportFO()

ilCertificateGUI::certificateExportFO ( )

Exports the certificate.

Exceptions

FileAlreadyExistsException
FileNotFoundException
IOException

Definition at line 204 of file class.ilCertificateGUI.php.

                                         : void
    {
        $this->exportAction->export();
    }

◆ certificateImport()

ilCertificateGUI::certificateImport ( )

Definition at line 183 of file class.ilCertificateGUI.php.

                                       : void
    {
        $this->certificateEditor();
    }

◆ certificatePreview()

ilCertificateGUI::certificatePreview ( )

Definition at line 188 of file class.ilCertificateGUI.php.

                                        : void
    {
        try {
            $this->previewAction->createPreviewPdf($this->objectId);
        } catch (Exception) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('error_creating_certificate_pdf'));
            $this->certificateEditor();
        }
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ certificateSave()

ilCertificateGUI::certificateSave ( )

Saves the certificate.

Exceptions

FileAlreadyExistsException
FileNotFoundException
IOException
ilDatabaseException
ilException
ilWACException

Definition at line 242 of file class.ilCertificateGUI.php.

                                     : void
    {
        global $DIC;
 
        $form = $this->settingsFormFactory->createForm(
            $this
        );
 
        $form->setValuesByPost();
 
        $request = $DIC->http()->request();
 
        $formFields = $request->getParsedBody();
 
        $this->tpl->setVariable('ADM_CONTENT', $form->getHTML());
 
        $this->saveCertificate($form, $formFields, $this->objectId);
    }

References $DIC, and saveCertificate().

Here is the call graph for this function:

◆ certificateUpload()

ilCertificateGUI::certificateUpload ( )

Exceptions

FileAlreadyExistsException
FileNotFoundException
IOException
ilDatabaseException
ilException
ilObjectNotFoundException
ilWACException

Definition at line 270 of file class.ilCertificateGUI.php.

                                       : void
    {
        $this->certificateEditor();
    }

◆ createFormatArray()

ilCertificateGUI::createFormatArray ( ilCertificateTemplate $certificateTemplate )

private

Definition at line 478 of file class.ilCertificateGUI.php.

                                                                                  : array
    {
        if ('' === $certificateTemplate->getCertificateHash()) {
            $format = $this->settings->get('pageformat', '');
            $formats = $this->pageFormats->fetchPageFormats();
 
            return [
                'pageformat' => $format,
                'pagewidth' => $formats['width'] ?? '',
                'pageheight' => $formats['height'] ?? '',
                'margin_body_top' => ilPageFormats::DEFAULT_MARGIN_BODY_TOP,
                'margin_body_right' => ilPageFormats::DEFAULT_MARGIN_BODY_RIGHT,
                'margin_body_bottom' => ilPageFormats::DEFAULT_MARGIN_BODY_BOTTOM,
                'margin_body_left' => ilPageFormats::DEFAULT_MARGIN_BODY_LEFT,
                'certificate_text' => $certificateTemplate->getCertificateContent()
            ];
        }
 
        return $this->settingsFormFactory->fetchFormFieldData($certificateTemplate->getCertificateContent());
    }

References ilPageFormats\DEFAULT_MARGIN_BODY_BOTTOM, ilPageFormats\DEFAULT_MARGIN_BODY_LEFT, ilPageFormats\DEFAULT_MARGIN_BODY_RIGHT, ilPageFormats\DEFAULT_MARGIN_BODY_TOP, ilCertificateTemplate\getCertificateContent(), ilCertificateTemplate\getCertificateHash(), and ILIAS\Repository\settings().

Referenced by getEditorForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilCertificateGUI::executeCommand ( )

Returns: mixed|null

Exceptions

FileAlreadyExistsException
FileNotFoundException
IOException
ilCtrlException
ilDatabaseException
ilException
ilWACException

Definition at line 155 of file class.ilCertificateGUI.php.

    {
        $cmd = $this->ctrl->getCmd(self::EDITOR_COMMAND);
        $next_class = $this->ctrl->getNextClass($this);
 
        $ret = null;
 
        $cmd = $this->getCommand($cmd);
        switch ($next_class) {
            case 'ilpropertyformgui':
                $form = $this->getEditorForm();
                $this->ctrl->forwardCommand($form);
 
                break;
            default:
                $ret = $this->$cmd();
 
                break;
        }
 
        return $ret;
    }

References ILIAS\Repository\ctrl(), getCommand(), and getEditorForm().

Here is the call graph for this function:

◆ getCommand()

ilCertificateGUI::getCommand ( $cmd )

Definition at line 178 of file class.ilCertificateGUI.php.

    {
        return $cmd;
    }

Referenced by executeCommand().

Here is the caller graph for this function:

◆ getEditorForm()

ilCertificateGUI::getEditorForm ( )

private

Exceptions

FileAlreadyExistsException
FileNotFoundException
IOException
ilDatabaseException
ilException
ilWACException

Definition at line 325 of file class.ilCertificateGUI.php.

                                    : ilPropertyFormGUI
    {
        $certificateTemplate = $this->templateRepository->fetchCurrentlyUsedCertificate($this->objectId);
 
        $form = $this->settingsFormFactory->createForm(
            $this
        );
 
        $formFields = $this->createFormatArray($certificateTemplate);
 
        $formFields['active'] = $certificateTemplate->isCurrentlyActive();
 
        $form->setValuesByArray($formFields);
 
        return $form;
    }

References createFormatArray().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveCertificate()

ilCertificateGUI::saveCertificate	(	ilPropertyFormGUI	$form,
		array	$form_fields,
		int	$objId
	)

private

Definition at line 342 of file class.ilCertificateGUI.php.

                                                                                             : void
    {
        $certificate_handler = new CertificateResourceHandler(
            new ilUserCertificateRepository($this->database),
            new ilCertificateTemplateDatabaseRepository($this->database),
            $this->irss,
            $this->global_certificate_settings,
            $this->stakeholder,
        );
        $current_template = $this->templateRepository->fetchPreviousCertificate($objId);
        $currentVersion = $current_template->getVersion();
        $nextVersion = $currentVersion + 1;
        $current_background_rid = $this->irss->manageContainer()->find(
            $current_template->getBackgroundImageIdentification()
        );
        $current_tile_image_rid = $this->irss->manageContainer()->find(
            $current_template->getTileImageIdentification()
        );
 
        $should_delete_background =
            $this->httpWrapper->post()->retrieve(
                'background_delete',
                $this->refinery->byTrying([
                    $this->refinery->kindlyTo()->bool(),
                    $this->refinery->always(false)
                ])
            );
        $should_delete_tile_image =
            $this->httpWrapper->post()->retrieve(
                'certificate_card_tile_image_delete',
                $this->refinery->byTrying([
                    $this->refinery->kindlyTo()->bool(),
                    $this->refinery->always(false)
                ])
            );
 
        $new_background_rid = $current_background_rid && !$should_delete_background ? $current_background_rid :
            $this->global_certificate_settings->getBackgroundImageIdentification();
 
        $new_tile_rid = !$should_delete_tile_image ? $current_tile_image_rid : null;
        if ($form->checkInput()) {
            try {
                $this->settingsFormFactory->save($form_fields);
 
                $templateValues = $this->placeholderDescriptionObject->getPlaceholderDescriptions();
 
                if ($this->fileUpload->hasUploads()) {
                    if (!$this->fileUpload->hasBeenProcessed()) {
                        $this->fileUpload->process();
                    }
                    $new_background = $form->getInput('background')['tmp_name'] ?? '';
                    $new_tile_image = $form->getInput('certificate_card_tile_image')['tmp_name'] ?? '';
                    $results = $this->fileUpload->getResults();
 
                    if ($new_background !== '') {
                        $new_background_rid = $this->irss->manage()->upload(
                            $results[$new_background],
                            $this->stakeholder
                        );
                    }
 
                    if ($new_tile_image !== '') {
                        $new_tile_rid = $this->irss->manage()->upload(
                            $results[$new_tile_image],
                            $this->stakeholder
                        );
                    }
                }
 
                $jsonEncodedTemplateValues = json_encode($templateValues, JSON_THROW_ON_ERROR);
 
                $xslfo = $this->xlsFoParser->parse($form_fields);
                $newHashValue = hash(
                    'sha256',
                    implode('', [
                        $xslfo,
                        isset($new_background_rid) ? $new_background_rid->serialize() : '',
                        $jsonEncodedTemplateValues,
                        isset($new_tile_rid) ? $new_background_rid->serialize() : ''
                    ])
                );
 
                $active = (bool) ($form_fields['active'] ?? false);
 
                if ($newHashValue !== $current_template->getCertificateHash()) {
                    $certificateTemplate = new ilCertificateTemplate(
                        $objId,
                        ilObject::_lookupType($objId),
                        $xslfo,
                        $newHashValue,
                        $jsonEncodedTemplateValues,
                        $nextVersion,
                        ILIAS_VERSION_NUMERIC,
                        time(),
                        $active,
                        isset($new_background_rid) ? $new_background_rid->serialize() : '',
                        isset($new_tile_rid) ? $new_tile_rid->serialize() : '',
                    );
                    $this->templateRepository->save($certificateTemplate);
 
                    if ($current_background_rid instanceof ResourceIdentification) {
                        $certificate_handler->handleResourceChange($current_background_rid);
                    }
                    if ($current_tile_image_rid instanceof ResourceIdentification) {
                        $certificate_handler->handleResourceChange($current_tile_image_rid);
                    }
 
                    $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'), true);
                    $this->ctrl->redirect($this, self::EDITOR_COMMAND);
                }
 
                if (
                    $current_template->getId() !== null &&
                    $current_template->isCurrentlyActive() !== $active
                ) {
                    $this->templateRepository->updateActivity($current_template, $active);
                    $this->tpl->setOnScreenMessage('info', $this->lng->txt('certificate_change_active_status'), true);
                    $this->ctrl->redirect($this, self::EDITOR_COMMAND);
                }
 
                $this->tpl->setOnScreenMessage('info', $this->lng->txt('certificate_same_not_saved'), true);
                $this->ctrl->redirect($this, self::EDITOR_COMMAND);
            } catch (Exception $e) {
                $this->tpl->setOnScreenMessage(
                    'failure',
                    $e->getMessage()
                );
                $this->logger->error($e->getTraceAsString());
            }
        }
 
        $form->setValuesByPost();
 
        $this->tpl->setVariable('ADM_CONTENT', $form->getHTML());
    }

References Vendor\Package\$e, $objId, $results, ilObject\_lookupType(), ilPropertyFormGUI\checkInput(), ILIAS\Repository\ctrl(), ILIAS\Repository\database(), ilPropertyFormGUI\getHTML(), ilPropertyFormGUI\getInput(), ILIAS_VERSION_NUMERIC, ILIAS\Repository\lng(), ILIAS\Repository\logger(), ILIAS\Repository\refinery(), and ilPropertyFormGUI\setValuesByPost().

Referenced by certificateSave().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $access

ilAccessHandler ilCertificateGUI::$access

protected

Definition at line 50 of file class.ilCertificateGUI.php.

◆ $certificate_repo

ilCertificateTemplateDatabaseRepository ilCertificateGUI::$certificate_repo

private

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

◆ $certificatePath

readonly string ilCertificateGUI::$certificatePath

private

Definition at line 64 of file class.ilCertificateGUI.php.

Referenced by __construct().

◆ $ctrl

ilCtrlInterface ilCertificateGUI::$ctrl

protected

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

◆ $database

readonly ilDBInterface ilCertificateGUI::$database

private

Definition at line 68 of file class.ilCertificateGUI.php.

◆ $deleteAction

readonly ilCertificateDeleteAction ilCertificateGUI::$deleteAction

private

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

Referenced by __construct().

◆ $exportAction

readonly ilCertificateTemplateExportAction ilCertificateGUI::$exportAction

private

Definition at line 61 of file class.ilCertificateGUI.php.

Referenced by __construct().

◆ $fileUpload

readonly FileUpload ilCertificateGUI::$fileUpload

private

Definition at line 63 of file class.ilCertificateGUI.php.

Referenced by __construct().

◆ $global_certificate_settings

readonly ilObjCertificateSettings ilCertificateGUI::$global_certificate_settings

private

Definition at line 67 of file class.ilCertificateGUI.php.

◆ $httpWrapper

readonly WrapperFactory ilCertificateGUI::$httpWrapper

private

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

◆ $ilias

ILIAS ilCertificateGUI::$ilias

protected

Definition at line 46 of file class.ilCertificateGUI.php.

◆ $irss

IRSS ilCertificateGUI::$irss

private

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

◆ $lng

ilLanguage ilCertificateGUI::$lng

protected

Definition at line 48 of file class.ilCertificateGUI.php.

◆ $logger

readonly ilLogger ilCertificateGUI::$logger

private

Definition at line 66 of file class.ilCertificateGUI.php.

◆ $pageFormats

readonly ilPageFormats ilCertificateGUI::$pageFormats

private

Definition at line 65 of file class.ilCertificateGUI.php.

Referenced by __construct().

◆ $previewAction

readonly ilCertificateTemplatePreviewAction ilCertificateGUI::$previewAction

private

Definition at line 62 of file class.ilCertificateGUI.php.

Referenced by __construct().

◆ $ref_id

int ilCertificateGUI::$ref_id

protected

Definition at line 49 of file class.ilCertificateGUI.php.

◆ $refinery

readonly Factory ilCertificateGUI::$refinery

private

Definition at line 53 of file class.ilCertificateGUI.php.

◆ $settingsFormFactory

readonly ilCertificateFormRepository ilCertificateGUI::$settingsFormFactory

private

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

Referenced by __construct().

◆ $stakeholder

ilCertificateTemplateStakeholder ilCertificateGUI::$stakeholder

private

Definition at line 55 of file class.ilCertificateGUI.php.

◆ $templateRepository

readonly ilCertificateTemplateRepository ilCertificateGUI::$templateRepository

private

Definition at line 57 of file class.ilCertificateGUI.php.

Referenced by __construct().

◆ $toolbar

ilToolbarGUI ilCertificateGUI::$toolbar

protected

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

◆ $tpl

ilGlobalPageTemplate ilCertificateGUI::$tpl

protected

Definition at line 47 of file class.ilCertificateGUI.php.

◆ $tree

ilTree ilCertificateGUI::$tree

protected

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

◆ $xlsFoParser

readonly ilXlsFoParser ilCertificateGUI::$xlsFoParser

private

Definition at line 59 of file class.ilCertificateGUI.php.

Referenced by __construct().

◆ EDITOR_COMMAND

const string ilCertificateGUI::EDITOR_COMMAND = 'certificateEditor'

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

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

components/ILIAS/Certificate/classes/class.ilCertificateGUI.php

Public Member Functions

Data Fields

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ certificateDelete()

◆ certificateDeleteConfirm()

◆ certificateExportFO()

◆ certificateImport()

◆ certificatePreview()

◆ certificateSave()

◆ certificateUpload()

◆ createFormatArray()

◆ executeCommand()

◆ getCommand()

◆ getEditorForm()

◆ saveCertificate()

Field Documentation

◆ $access

◆ $certificate_repo

◆ $certificatePath

◆ $ctrl

◆ $database

◆ $deleteAction

◆ $exportAction

◆ $fileUpload

◆ $global_certificate_settings

◆ $httpWrapper

◆ $ilias

◆ $irss

◆ $lng

◆ $logger

◆ $pageFormats

◆ $previewAction

◆ $ref_id

◆ $refinery

◆ $settingsFormFactory

◆ $stakeholder

◆ $templateRepository

◆ $toolbar

◆ $tpl

◆ $tree

◆ $xlsFoParser

◆ EDITOR_COMMAND