GUI class to create PDF certificates. More...

Collaboration diagram for ilCertificateGUI:

Public Member Functions
	__construct (ilCertificateAdapter $adapter, 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, \ILIAS\Filesystem\Filesystem $fileSystem=null)
	ilCertificateGUI constructor More...

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

	$ctrl

	$tree

	$ilias

	$tpl

	$lng

	$ref_id

	$access

	$toolbar

Private Member Functions
	getEditorForm ()

	setTemplateContent (ilCertificateTemplate $certificate, ilPropertyFormGUI $form)

	createFormatArray (ilCertificateTemplate $certificateTemplate)

Private Attributes
	$fileSystem

	$templateRepository

	$formFieldParser

	$placeholderDescriptionObject

	$objectId

	$settingsFormFactory

	$placeholderValuesObject

	$xlsFoParser

	$deleteAction

	$exportAction

	$backgroundImageUpload

	$previewAction

	$thumbnailImageUpload

	$fileUpload

	$certificatePath

	$settings

	$pageFormats

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

Constructor & Destructor Documentation

◆ __construct()

ilCertificateGUI::__construct	(	ilCertificateAdapter	$adapter,
		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`,
		\ILIAS\Filesystem\Filesystem	$fileSystem = `null`
	)

ilCertificateGUI constructor

Parameters

ilCertificateAdapter	$adapter	A reference to the test container object
ilCertificatePlaceholderDescription	$placeholderDescriptionObject
ilCertificatePlaceholderValues	$placeholderValuesObject
	$objectId
	$certificatePath
ilCertificateFormRepository	$settingsFormFactory
ilCertificateDeleteAction	$deleteAction
ilCertificateTemplateRepository \| null	$templateRepository
ilPageFormats \| null	$pageFormats
ilXlsFoParser \| null	$xlsFoParser
ilFormFieldParser	$formFieldParser
ilCertificateTemplateExportAction \| null	$exportAction
ilCertificateBackgroundImageUpload \| null	$upload
ilCertificateTemplatePreviewAction \| null	$previewAction
\ILIAS\FileUpload\FileUpload \| null	$fileUpload
ilSetting \| null	$setting	public

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

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

       {
         global $DIC;
 
 
         $this->certifcateObject = new ilCertificate(
             $adapter,
             $placeholderDescriptionObject,
             $placeholderValuesObject,
             $objectId,
             $certificatePath
         );
 
         $this->lng = $DIC['lng'];
         $this->tpl = $DIC['tpl'];
         $this->ctrl = $DIC['ilCtrl'];
         $this->ilias = $DIC['ilias'];
         $this->tree = $DIC['tree'];
         $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;
     }

Here is the call graph for this function:

Member Function Documentation

◆ certificateDelete()

ilCertificateGUI::certificateDelete ( )

Deletes the certificate and all its data.

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

References $template.

     {
         $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 389 of file class.ilCertificateGUI.php.

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

◆ certificateImport()

ilCertificateGUI::certificateImport ( )

Import a certificate from a ZIP archive.

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

     {
         $this->certificateEditor();
     }

◆ certificatePreview()

ilCertificateGUI::certificatePreview ( )

Creates a certificate preview.

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

     {
         $this->certifcateObject->deleteBackgroundImage();
         $this->certificateEditor();
     }

◆ certificateSave()

ilCertificateGUI::certificateSave ( )

Saves the certificate.

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

References $DIC, $form, and $request.

     {
         global $DIC;
 
         $form = $this->settingsFormFactory->createForm(
             $this,
             $this->certifcateObject
         );
 
         $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 456 of file class.ilCertificateGUI.php.

     {
         $this->certificateEditor();
     }

◆ createFormatArray()

ilCertificateGUI::createFormatArray ( ilCertificateTemplate $certificateTemplate )

private

Parameters

ilCertificateTemplate $certificateTemplate

Returns: array|mixed

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

References $form, $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 360 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 470 of file class.ilCertificateGUI.php.

References $_POST, $DIC, $form, $result, ilObjUserTracking\_enabledLearningProgress(), ilObject\_lookupType(), ilPropertyFormGUI\checkInput(), createFormatArray(), ilObjCertificateSettingsAccess\getBackgroundImagePath(), ilPropertyFormGUI\getHTML(), ilObjectFactory\getInstanceByObjId(), ilPropertyFormGUI\getItemByPostVar(), GuzzleHttp\Psr7\hash(), 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,
             $this->certifcateObject
         );
 
         $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 662 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 92 of file class.ilCertificateGUI.php.

◆ $backgroundImageUpload

ilCertificateGUI::$backgroundImageUpload

private

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

◆ $certifcateObject

ilCertificateGUI::$certifcateObject

protected

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

◆ $certificatePath

ilCertificateGUI::$certificatePath

private

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

Referenced by __construct().

◆ $ctrl

ilCertificateGUI::$ctrl

protected

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

◆ $deleteAction

ilCertificateGUI::$deleteAction

private

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

Referenced by __construct().

◆ $exportAction

ilCertificateGUI::$exportAction

private

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

Referenced by __construct().

◆ $fileSystem

ilCertificateGUI::$fileSystem

private

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

Referenced by __construct().

◆ $fileUpload

ilCertificateGUI::$fileUpload

private

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

Referenced by __construct().

◆ $formFieldParser

ilCertificateGUI::$formFieldParser

private

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

Referenced by __construct().

◆ $ilias

ilCertificateGUI::$ilias

protected

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

◆ $lng

ilCertificateGUI::$lng

protected

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

◆ $objectId

ilCertificateGUI::$objectId

private

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

Referenced by __construct().

◆ $pageFormats

ilCertificateGUI::$pageFormats

private

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

Referenced by __construct().

◆ $placeholderDescriptionObject

ilCertificateGUI::$placeholderDescriptionObject

private

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

Referenced by __construct().

◆ $placeholderValuesObject

ilCertificateGUI::$placeholderValuesObject

private

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

Referenced by __construct().

◆ $previewAction

ilCertificateGUI::$previewAction

private

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

Referenced by __construct().

◆ $ref_id

ilCertificateGUI::$ref_id

protected

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

◆ $settings

ilCertificateGUI::$settings

private

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

Referenced by __construct().

◆ $settingsFormFactory

ilCertificateGUI::$settingsFormFactory

private

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

Referenced by __construct().

◆ $templateRepository

ilCertificateGUI::$templateRepository

private

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

Referenced by __construct().

◆ $thumbnailImageUpload

ilCertificateGUI::$thumbnailImageUpload

private

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

◆ $toolbar

ilCertificateGUI::$toolbar

protected

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

◆ $tpl

ilCertificateGUI::$tpl

protected

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

◆ $tree

ilCertificateGUI::$tree

protected

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

◆ $xlsFoParser

ilCertificateGUI::$xlsFoParser

private

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

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

◆ $backgroundImageUpload

◆ $certifcateObject

◆ $certificatePath

◆ $ctrl

◆ $deleteAction

◆ $exportAction

◆ $fileSystem

◆ $fileUpload

◆ $formFieldParser

◆ $ilias

◆ $lng

◆ $objectId

◆ $pageFormats

◆ $placeholderDescriptionObject

◆ $placeholderValuesObject

◆ $previewAction

◆ $ref_id

◆ $settings

◆ $settingsFormFactory

◆ $templateRepository

◆ $thumbnailImageUpload

◆ $toolbar

◆ $tpl

◆ $tree

◆ $xlsFoParser