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, ?ilCertificateBackgroundImageUpload $upload=null, ?ilCertificateTemplatePreviewAction $previewAction=null, ?FileUpload $fileUpload=null, private readonly ilSetting $settings=new ilSetting('certificate'), ?ilCertificateBackgroundImageDelete $backgroundImageDelete=null, ?Filesystem $fileSystem=null, ?ilCertificateBackgroundImageFileService $imageFileService=null, ?Filesystem $tmp_file_system=null)

	executeCommand ()

	getCommand ($cmd)

	certificateImport ()

	certificatePreview ()

	certificateExportFO ()
	Exports the certificate. More...

	certificateRemoveBackground ()

	certificateDelete ()

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

	certificateSave ()
	Saves the certificate. More...

	certificateUpload ()

Protected Attributes
ilCtrlInterface	$ctrl

ilTree	$tree

ILIAS	$ilias

ilGlobalPageTemplate	$tpl

ilLanguage	$lng

int	$ref_id

ilAccessHandler	$access

ilToolbarGUI	$toolbar

Private Member Functions
	getEditorForm ()

	createFormatArray (ilCertificateTemplate $certificateTemplate)

Private Attributes
readonly ilCertificateBackgroundImageDelete	$backgroundImageDelete

readonly Filesystem	$fileSystem

readonly WrapperFactory	$httpWrapper

readonly Factory	$refinery

readonly ilCertificateTemplateRepository	$templateRepository

readonly ilCertificateFormRepository	$settingsFormFactory

readonly ilXlsFoParser	$xlsFoParser

readonly ilCertificateDeleteAction	$deleteAction

readonly ilCertificateTemplateExportAction	$exportAction

readonly ilCertificateBackgroundImageUpload	$backgroundImageUpload

readonly ilCertificateTemplatePreviewAction	$previewAction

readonly FileUpload	$fileUpload

readonly string	$certificatePath

readonly ilPageFormats	$pageFormats

readonly Filesystem	$tmp_file_system

readonly ilLogger	$logger

readonly ilObjCertificateSettings	$global_certificate_settings

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$

ilCertificateGUI: ilPropertyFormGUI

Definition at line 38 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`,
		?ilCertificateBackgroundImageUpload	$upload = `null`,
		?ilCertificateTemplatePreviewAction	$previewAction = `null`,
		?FileUpload	$fileUpload = `null`,
		private readonly ilSetting	$settings = `new ilSetting('certificate')`,
		?ilCertificateBackgroundImageDelete	$backgroundImageDelete = `null`,
		?Filesystem	$fileSystem = `null`,
		?ilCertificateBackgroundImageFileService	$imageFileService = `null`,
		?Filesystem	$tmp_file_system = `null`
	)

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

References $certificatePath, $DIC, $logger, $pageFormats, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), ILIAS\Repository\refinery(), and ILIAS\Repository\toolbar().

       {
         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->tree = $DIC['tree'];
         $this->access = $DIC['ilAccess'];
         $this->toolbar = $DIC['ilToolbar'];
 
         $this->global_certificate_settings = new ilObjCertificateSettings();
 
         $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->backgroundImageUpload = $upload ?? new ilCertificateBackgroundImageUpload(
             $DIC->upload(),
             $certificatePath,
             $DIC->language()
         );
         $this->exportAction = $exportAction ?? new ilCertificateTemplateExportAction(
             $this->objectId,
             $certificatePath,
             $this->templateRepository,
             $DIC->filesystem()->web()
         );
         $this->previewAction = $previewAction ?? new ilCertificateTemplatePreviewAction(
             $this->templateRepository,
             $placeholderValuesObject
         );
         $this->fileUpload = $fileUpload ?? $DIC->upload();
         $this->certificatePath = $certificatePath;
         $this->fileSystem = $fileSystem ?? $DIC->filesystem()->web();
         $imageFileService ??= new ilCertificateBackgroundImageFileService(
             $this->certificatePath,
             $this->fileSystem
         );
         $this->backgroundImageDelete = $backgroundImageDelete ?? new ilCertificateBackgroundImageDelete(
             $this->certificatePath,
             $imageFileService
         );
         $this->tmp_file_system = $tmp_file_system ?? $DIC->filesystem()->temp();
         ;
     }

Here is the call graph for this function:

Member Function Documentation

◆ certificateDelete()

ilCertificateGUI::certificateDelete ( )

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

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

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

Here is the call graph for this function:

◆ certificateDeleteConfirm()

ilCertificateGUI::certificateDeleteConfirm ( )

Deletes the certificate and all its data.

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

References ILIAS\Repository\ctrl().

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

Here is the call graph for this function:

◆ certificateExportFO()

ilCertificateGUI::certificateExportFO ( )

Exports the certificate.

Exceptions

FileAlreadyExistsException
FileNotFoundException
IOException

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

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

◆ certificateImport()

ilCertificateGUI::certificateImport ( )

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

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

◆ certificatePreview()

ilCertificateGUI::certificatePreview ( )

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

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

◆ certificateRemoveBackground()

ilCertificateGUI::certificateRemoveBackground ( )

Exceptions

FileAlreadyExistsException
FileNotFoundException
IOException
ilDatabaseException
ilException
ilObjectNotFoundException
ilWACException

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

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

◆ certificateSave()

ilCertificateGUI::certificateSave ( )

Saves the certificate.

Exceptions

FileAlreadyExistsException
FileNotFoundException
IOException
ilDatabaseException
ilException
ilWACException

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

References $DIC.

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

◆ certificateUpload()

ilCertificateGUI::certificateUpload ( )

Exceptions

FileAlreadyExistsException
FileNotFoundException
IOException
ilDatabaseException
ilException
ilObjectNotFoundException
ilWACException

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

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

◆ createFormatArray()

ilCertificateGUI::createFormatArray ( ilCertificateTemplate $certificateTemplate )

private

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

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().

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

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 167 of file class.ilCertificateGUI.php.

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

     {
         $cmd = $this->ctrl->getCmd();
         $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;
     }

Here is the call graph for this function:

◆ getCommand()

ilCertificateGUI::getCommand ( $cmd )

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

Referenced by executeCommand().

     {
         return $cmd;
     }

Here is the caller graph for this function:

◆ getEditorForm()

ilCertificateGUI::getEditorForm ( )

private

Exceptions

FileAlreadyExistsException
FileNotFoundException
IOException
ilDatabaseException
ilException
ilWACException

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

References $DIC, Vendor\Package\$e, $objId, ilObjUserTracking\_enabledLearningProgress(), ilObject\_lookupType(), ilPropertyFormGUI\checkInput(), createFormatArray(), ILIAS\Repository\ctrl(), ilPropertyFormGUI\getHTML(), ilPropertyFormGUI\getInput(), ilObjectFactory\getInstanceByObjId(), ilPropertyFormGUI\getItemByPostVar(), ILIAS_VERSION_NUMERIC, ILIAS\Repository\lng(), ILIAS\Repository\logger(), ilLPObjSettings\LP_MODE_DEACTIVATED, ILIAS\Repository\refinery(), and ilPropertyFormGUI\setValuesByPost().

Referenced by executeCommand().

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

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.

◆ $backgroundImageDelete

readonly ilCertificateBackgroundImageDelete ilCertificateGUI::$backgroundImageDelete

private

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

◆ $backgroundImageUpload

readonly ilCertificateBackgroundImageUpload ilCertificateGUI::$backgroundImageUpload

private

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

◆ $certificatePath

readonly string ilCertificateGUI::$certificatePath

private

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

Referenced by __construct().

◆ $ctrl

ilCtrlInterface ilCertificateGUI::$ctrl

protected

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

◆ $deleteAction

readonly ilCertificateDeleteAction ilCertificateGUI::$deleteAction

private

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

◆ $exportAction

readonly ilCertificateTemplateExportAction ilCertificateGUI::$exportAction

private

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

◆ $fileSystem

readonly Filesystem ilCertificateGUI::$fileSystem

private

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

◆ $fileUpload

readonly FileUpload ilCertificateGUI::$fileUpload

private

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

◆ $global_certificate_settings

readonly ilObjCertificateSettings ilCertificateGUI::$global_certificate_settings

private

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

◆ $httpWrapper

readonly WrapperFactory ilCertificateGUI::$httpWrapper

private

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

◆ $ilias

ILIAS ilCertificateGUI::$ilias

protected

Definition at line 46 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 63 of file class.ilCertificateGUI.php.

Referenced by __construct().

◆ $pageFormats

readonly ilPageFormats ilCertificateGUI::$pageFormats

private

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

Referenced by __construct().

◆ $previewAction

readonly ilCertificateTemplatePreviewAction ilCertificateGUI::$previewAction

private

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

◆ $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 43 of file class.ilCertificateGUI.php.

◆ $settingsFormFactory

readonly ilCertificateFormRepository ilCertificateGUI::$settingsFormFactory

private

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

◆ $templateRepository

readonly ilCertificateTemplateRepository ilCertificateGUI::$templateRepository

private

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

◆ $tmp_file_system

readonly Filesystem ilCertificateGUI::$tmp_file_system

private

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

◆ $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 54 of file class.ilCertificateGUI.php.

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

Services/Certificate/classes/class.ilCertificateGUI.php

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ certificateDelete()

◆ certificateDeleteConfirm()

◆ certificateExportFO()

◆ certificateImport()

◆ certificatePreview()

◆ certificateRemoveBackground()

◆ certificateSave()

◆ certificateUpload()

◆ createFormatArray()

◆ executeCommand()

◆ getCommand()

◆ getEditorForm()

Field Documentation

◆ $access

◆ $backgroundImageDelete

◆ $backgroundImageUpload

◆ $certificatePath

◆ $ctrl

◆ $deleteAction

◆ $exportAction

◆ $fileSystem

◆ $fileUpload

◆ $global_certificate_settings

◆ $httpWrapper

◆ $ilias

◆ $lng

◆ $logger

◆ $pageFormats

◆ $previewAction

◆ $ref_id

◆ $refinery

◆ $settingsFormFactory

◆ $templateRepository

◆ $tmp_file_system

◆ $toolbar

◆ $tpl

◆ $tree

◆ $xlsFoParser