GUI class to create PDF certificates. More...

Collaboration diagram for ilCertificateGUI:

Public Member Functions
	__construct (ilCertificatePlaceholderDescription $placeholderDescriptionObject, ilCertificatePlaceholderValues $placeholderValuesObject, $objectId, $certificatePath, ilCertificateFormRepository $settingsFormFactory=null, ilCertificateDeleteAction $deleteAction=null, ilCertificateTemplateRepository $templateRepository=null, ilPageFormats $pageFormats=null, ilXlsFoParser $xlsFoParser=null, ilFormFieldParser $formFieldParser=null, ilCertificateTemplateExportAction $exportAction=null, ilCertificateBackgroundImageUpload $upload=null, ilCertificateTemplatePreviewAction $previewAction=null, \ILIAS\FileUpload\FileUpload $fileUpload=null, ilSetting $settings=null, ilCertificateBackgroundImageDelete $backgroundImageDelete=null, \ILIAS\Filesystem\Filesystem $fileSystem=null, ilCertificateBackgroundImageFileService $imageFileService=null, \ILIAS\Filesystem\Filesystem $tmp_file_system=null)

	executeCommand ()
	execute command More...

	getCommand ($cmd)
	Retrieves the ilCtrl command. More...

	certificateImport ()
	Import a certificate from a ZIP archive. More...

	certificatePreview ()
	Creates a certificate preview. More...

	certificateExportFO ()
	Exports the certificate. More...

	certificateRemoveBackground ()
	Removes the background image of a certificate. More...

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

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

	certificateSave ()
	Saves the certificate. More...

	certificateUpload ()
	Uploads the certificate. More...

Protected Attributes
	$ctrl

	$tree

	$ilias

	$tpl

	$lng

	$ref_id

	$access

	$toolbar

Private Member Functions
	getEditorForm ()

	setTemplateContent (ilCertificateTemplate $certificate, ilPropertyFormGUI $form)

	createFormatArray (ilCertificateTemplate $certificateTemplate)

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

Constructor & Destructor Documentation

◆ __construct()

ilCertificateGUI::__construct	(	ilCertificatePlaceholderDescription	$placeholderDescriptionObject,
		ilCertificatePlaceholderValues	$placeholderValuesObject,
			$objectId,
			$certificatePath,
		ilCertificateFormRepository	$settingsFormFactory = `null`,
		ilCertificateDeleteAction	$deleteAction = `null`,
		ilCertificateTemplateRepository	$templateRepository = `null`,
		ilPageFormats	$pageFormats = `null`,
		ilXlsFoParser	$xlsFoParser = `null`,
		ilFormFieldParser	$formFieldParser = `null`,
		ilCertificateTemplateExportAction	$exportAction = `null`,
		ilCertificateBackgroundImageUpload	$upload = `null`,
		ilCertificateTemplatePreviewAction	$previewAction = `null`,
		\ILIAS\FileUpload\FileUpload	$fileUpload = `null`,
		ilSetting	$settings = `null`,
		ilCertificateBackgroundImageDelete	$backgroundImageDelete = `null`,
		\ILIAS\Filesystem\Filesystem	$fileSystem = `null`,
		ilCertificateBackgroundImageFileService	$imageFileService = `null`,
		\ILIAS\Filesystem\Filesystem	$tmp_file_system = `null`
	)

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

References $_GET, $backgroundImageDelete, $certificatePath, $deleteAction, $DIC, $exportAction, $fileSystem, $fileUpload, $formFieldParser, $objectId, $pageFormats, $placeholderDescriptionObject, $placeholderValuesObject, $previewAction, $settings, $settingsFormFactory, $templateRepository, $tmp_file_system, $xlsFoParser, and settings().

       {
         global $DIC;
 
         $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->lng->loadLanguageModule('certificate');
         $this->lng->loadLanguageModule('cert');
         $this->lng->loadLanguageModule("trac");
 
         $this->ref_id = (int) $_GET['ref_id'];
 
         $this->placeholderDescriptionObject = $placeholderDescriptionObject;
 
         $this->placeholderValuesObject = $placeholderValuesObject;
 
         $this->objectId = $objectId;
 
         $logger = $DIC->logger()->cert();
 
         if (null === $settingsFormFactory) {
             $settingsFormFactory = new ilCertificateSettingsFormRepository(
                 $this->objectId,
                 $certificatePath,
                 $this->lng,
                 $this->tpl,
                 $this->ctrl,
                 $this->access,
                 $this->toolbar,
                 $placeholderDescriptionObject
             );
         }
         $this->settingsFormFactory = $settingsFormFactory;
 
         if (null === $templateRepository) {
             $templateRepository = new ilCertificateTemplateRepository($DIC->database(), $logger);
         }
         $this->templateRepository = $templateRepository;
 
         if (null === $deleteAction) {
             $deleteAction = new ilCertificateTemplateDeleteAction($templateRepository);
         }
         $this->deleteAction = $deleteAction;
 
         if (null === $formFieldParser) {
             $formFieldParser = new ilFormFieldParser();
         }
         $this->formFieldParser = $formFieldParser;
 
         if (null === $pageFormats) {
             $pageFormats = new ilPageFormats($DIC->language());
         }
         $this->pageFormats = $pageFormats;
 
         if (null === $xlsFoParser) {
             $xlsFoParser = new ilXlsFoParser($DIC->settings(), $pageFormats);
         }
         $this->xlsFoParser = $xlsFoParser;
 
         if (null === $upload) {
             $upload = new ilCertificateBackgroundImageUpload(
                 $DIC->upload(),
                 $certificatePath,
                 $DIC->language(),
                 $logger
             );
         }
         $this->backgroundImageUpload = $upload;
 
         if (null === $exportAction) {
             $exportAction = new ilCertificateTemplateExportAction(
                 $this->objectId,
                 $certificatePath,
                 $this->templateRepository,
                 $DIC->filesystem()->web()
             );
         }
         $this->exportAction = $exportAction;
 
         if (null === $previewAction) {
             $previewAction = new ilCertificateTemplatePreviewAction($templateRepository, $placeholderValuesObject);
         }
         $this->previewAction = $previewAction;
 
         if (null === $fileUpload) {
             global $DIC;
             $fileUpload = $DIC->upload();
         }
         $this->fileUpload = $fileUpload;
 
         $this->certificatePath = $certificatePath;
 
         if (null === $settings) {
             $settings = new ilSetting('certificate');
         }
         $this->settings = $settings;
 
         if (null === $fileSystem) {
             $fileSystem = $DIC->filesystem()->web();
         }
         $this->fileSystem = $fileSystem;
 
         if (null === $imageFileService) {
             $imageFileService = new ilCertificateBackgroundImageFileService(
                 $this->certificatePath,
                 $this->fileSystem
             );
         }
 
         if (null === $backgroundImageDelete) {
             $backgroundImageDelete = new ilCertificateBackgroundImageDelete(
                 $this->certificatePath,
                 $imageFileService
             );
         }
         $this->backgroundImageDelete = $backgroundImageDelete;
         
         if (null === $tmp_file_system) {
             $tmp_file_system = $DIC->filesystem()->temp();
         }
         $this->tmp_file_system = $tmp_file_system;
     }

Here is the call graph for this function:

Member Function Documentation

◆ certificateDelete()

ilCertificateGUI::certificateDelete ( )

Deletes the certificate and all its data.

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

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

◆ certificateDeleteConfirm()

ilCertificateGUI::certificateDeleteConfirm ( )

Deletes the certificate and all its data.

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

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

◆ certificateExportFO()

ilCertificateGUI::certificateExportFO ( )

Exports the certificate.

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

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

◆ certificateImport()

ilCertificateGUI::certificateImport ( )

Import a certificate from a ZIP archive.

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

     {
         $this->certificateEditor();
     }

◆ certificatePreview()

ilCertificateGUI::certificatePreview ( )

Creates a certificate preview.

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

References ilUtil\sendFailure().

     {
         try {
             $this->previewAction->createPreviewPdf($this->objectId);
         } catch (Exception $exception) {
             ilUtil::sendFailure($this->lng->txt('error_creating_certificate_pdf', true));
             $this->certificateEditor();
         }
     }

Here is the call graph for this function:

◆ certificateRemoveBackground()

ilCertificateGUI::certificateRemoveBackground ( )

Removes the background image of a certificate.

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

     {
         $this->backgroundImageDelete->deleteBackgroundImage('');
         $this->certificateEditor();
     }

◆ certificateSave()

ilCertificateGUI::certificateSave ( )

Saves the certificate.

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

References $DIC.

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

Uploads the certificate.

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

     {
         $this->certificateEditor();
     }

◆ createFormatArray()

ilCertificateGUI::createFormatArray ( ilCertificateTemplate $certificateTemplate )

private

Parameters

ilCertificateTemplate $certificateTemplate

Returns: array|mixed

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

References $format, $formats, 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 settings().

Referenced by getEditorForm().

     {
         if ('' === $certificateTemplate->getCertificateHash()) {
             $format = $this->settings->get('pageformat');
             $formats = $this->pageFormats->fetchPageFormats();
 
             $formFieldArray = array(
                 '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 $formFieldArray;
         }
         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 ( )

execute command

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

References $ret, getCommand(), and getEditorForm().

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

Retrieves the ilCtrl command.

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

Referenced by executeCommand().

     {
         return $cmd;
     }

Here is the caller graph for this function:

◆ getEditorForm()

ilCertificateGUI::getEditorForm ( )

private

Returns: ilPropertyFormGUI

Exceptions

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

References $_POST, $DIC, Vendor\Package\$e, $objId, $result, ilObjUserTracking\_enabledLearningProgress(), ilObject\_lookupType(), ilPropertyFormGUI\checkInput(), createFormatArray(), ilObjCertificateSettingsAccess\getBackgroundImagePath(), ilPropertyFormGUI\getHTML(), ilPropertyFormGUI\getInput(), ilObjectFactory\getInstanceByObjId(), ilPropertyFormGUI\getItemByPostVar(), ILIAS_VERSION_NUMERIC, ilLPObjSettings\LP_MODE_DEACTIVATED, ILIAS\FileUpload\DTO\ProcessingStatus\OK, ilUtil\sendFailure(), ilUtil\sendInfo(), 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:

◆ setTemplateContent()

ilCertificateGUI::setTemplateContent	(	ilCertificateTemplate	$certificate,
		ilPropertyFormGUI	$form
	)

private

Parameters

$content
$certificate
$form

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

References ilCertificateTemplate\getCertificateContent(), ilPropertyFormGUI\getHTML(), ilCertificateTemplate\isCurrentlyActive(), and ilPropertyFormGUI\setValuesByArray().

     {
         $form_fields = $this->settingsFormFactory->fetchFormFieldData($certificate->getCertificateContent());
         $form_fields['active'] = $certificate->isCurrentlyActive();
 
         $form->setValuesByArray($form_fields);
 
         $this->tpl->setVariable("ADM_CONTENT", $form->getHTML());
     }

Here is the call graph for this function:

Field Documentation

◆ $access

ilCertificateGUI::$access

protected

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

◆ $backgroundImageDelete

ilCertificateGUI::$backgroundImageDelete

private

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

Referenced by __construct().

◆ $backgroundImageUpload

ilCertificateGUI::$backgroundImageUpload

private

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

◆ $certificatePath

ilCertificateGUI::$certificatePath

private

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

Referenced by __construct().

◆ $ctrl

ilCertificateGUI::$ctrl

protected

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

◆ $deleteAction

ilCertificateGUI::$deleteAction

private

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

Referenced by __construct().

◆ $exportAction

ilCertificateGUI::$exportAction

private

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

Referenced by __construct().

◆ $fileSystem

ilCertificateGUI::$fileSystem

private

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

Referenced by __construct().

◆ $fileUpload

ilCertificateGUI::$fileUpload

private

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

Referenced by __construct().

◆ $formFieldParser

ilCertificateGUI::$formFieldParser

private

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

Referenced by __construct().

◆ $ilias

ilCertificateGUI::$ilias

protected

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

◆ $lng

ilCertificateGUI::$lng

protected

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

◆ $objectId

ilCertificateGUI::$objectId

private

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

Referenced by __construct().

◆ $pageFormats

ilCertificateGUI::$pageFormats

private

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

Referenced by __construct().

◆ $placeholderDescriptionObject

ilCertificateGUI::$placeholderDescriptionObject

private

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

Referenced by __construct().

◆ $placeholderValuesObject

ilCertificateGUI::$placeholderValuesObject

private

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

Referenced by __construct().

◆ $previewAction

ilCertificateGUI::$previewAction

private

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

Referenced by __construct().

◆ $ref_id

ilCertificateGUI::$ref_id

protected

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

◆ $settings

ilCertificateGUI::$settings

private

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

Referenced by __construct().

◆ $settingsFormFactory

ilCertificateGUI::$settingsFormFactory

private

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

Referenced by __construct().

◆ $templateRepository

ilCertificateGUI::$templateRepository

private

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

Referenced by __construct().

◆ $thumbnailImageUpload

ilCertificateGUI::$thumbnailImageUpload

private

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

◆ $tmp_file_system

ilCertificateGUI::$tmp_file_system

private

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

Referenced by __construct().

◆ $toolbar

ilCertificateGUI::$toolbar

protected

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

◆ $tpl

ilCertificateGUI::$tpl

protected

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

◆ $tree

ilCertificateGUI::$tree

protected

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

◆ $xlsFoParser

ilCertificateGUI::$xlsFoParser

private

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

Referenced by __construct().

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

Services/Certificate/classes/class.ilCertificateGUI.php

Private Attributes
	$backgroundImageDelete

	$fileSystem

	$templateRepository

	$formFieldParser

	$placeholderDescriptionObject

	$objectId

	$settingsFormFactory

	$placeholderValuesObject

	$xlsFoParser

	$deleteAction

	$exportAction

	$backgroundImageUpload

	$previewAction

	$thumbnailImageUpload

	$fileUpload

	$certificatePath

	$settings

	$pageFormats

	$tmp_file_system

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

◆ setTemplateContent()

Field Documentation

◆ $access

◆ $backgroundImageDelete

◆ $backgroundImageUpload

◆ $certificatePath

◆ $ctrl

◆ $deleteAction

◆ $exportAction

◆ $fileSystem

◆ $fileUpload

◆ $formFieldParser

◆ $ilias

◆ $lng

◆ $objectId

◆ $pageFormats

◆ $placeholderDescriptionObject

◆ $placeholderValuesObject

◆ $previewAction

◆ $ref_id

◆ $settings

◆ $settingsFormFactory

◆ $templateRepository

◆ $thumbnailImageUpload

◆ $tmp_file_system

◆ $toolbar

◆ $tpl

◆ $tree

◆ $xlsFoParser