ilCertificateSettingsFormRepository Class Reference

Inheritance diagram for ilCertificateSettingsFormRepository:

Collaboration diagram for ilCertificateSettingsFormRepository:

Public Member Functions
	__construct (int $objectId, string $certificatePath, bool $hasAdditionalElements, ilLanguage $language, ilCtrl $controller, ilAccess $access, ilToolbarGUI $toolbar, ilCertificatePlaceholderDescription $placeholderDescriptionObject, ilPageFormats $pageFormats=null, ilFormFieldParser $formFieldParser=null, ilCertificateTemplateImportAction $importAction=null, ilLogger $logger=null, ilCertificateTemplateRepository $templateRepository=null, \ILIAS\Filesystem\Filesystem $filesystem=null, ilCertificateBackgroundImageFileService $backgroundImageFileService=null)
	createForm (ilCertificateGUI $certificateGUI)
	save (array $formFields)
	fetchFormFieldData (string $content)
	createForm (ilCertificateGUI $certificateGUI)
	save (array $formFields)
	fetchFormFieldData (string $content)

Private Attributes
	$objectId
	$language
	$controller
	$access
	$toolbar
	$placeholderDescriptionObject
	$pageFormats
	$formFieldParser
	$importAction
	$templateRepository
	$certificatePath
	$hasAdditionalElements
	$backGroundImageFileService
	$globalCertificateSettings

Detailed Description

Author

Niels Theen nthee.nosp@m.n@da.nosp@m.tabay.nosp@m..de

Definition at line 7 of file class.ilCertificateSettingsFormRepository.php.

Constructor & Destructor Documentation

__construct()

ilCertificateSettingsFormRepository::__construct	(	int	$objectId,
		string	$certificatePath,
		bool	$hasAdditionalElements,
		ilLanguage	$language,
		ilCtrl	$controller,
		ilAccess	$access,
		ilToolbarGUI	$toolbar,
		ilCertificatePlaceholderDescription	$placeholderDescriptionObject,
		ilPageFormats	$pageFormats = null,
		ilFormFieldParser	$formFieldParser = null,
		ilCertificateTemplateImportAction	$importAction = null,
		ilLogger	$logger = null,
		ilCertificateTemplateRepository	$templateRepository = null,
		\ILIAS\Filesystem\Filesystem	$filesystem = null,
		ilCertificateBackgroundImageFileService	$backgroundImageFileService = null
	)

Parameters

integer	$objectId
string	$certificatePath
ilLanguage	$language
ilCtrl	$controller
ilAccess	$access
ilToolbarGUI	$toolbar
ilCertificatePlaceholderDescription	$placeholderDescriptionObject
ilPageFormats | null	$pageFormats
ilFormFieldParser | null	$formFieldParser
ilCertificateTemplateImportAction | null	$importAction
ilLogger | null	$logger
ilCertificateTemplateRepository | null	$templateRepository

Definition at line 92 of file class.ilCertificateSettingsFormRepository.php.

      {
        global $DIC;
 
        $this->objectId = $objectId;
        $this->language = $language;
        $this->controller = $controller;
        $this->access = $access;
        $this->toolbar = $toolbar;
        $this->placeholderDescriptionObject = $placeholderDescriptionObject;
        $this->certificatePath = $certificatePath;
        $this->hasAdditionalElements = $hasAdditionalElements;
        $this->globalCertificateSettings = new ilObjCertificateSettings();
 
        $database = $DIC->database();
 
 
        if (null === $logger) {
            $logger = $logger = $DIC->logger()->cert();
        }
 
        if (null === $pageFormats) {
            $pageFormats = new ilPageFormats($language);
        }
        $this->pageFormats = $pageFormats;
 
        if (null === $formFieldParser) {
            $formFieldParser = new ilFormFieldParser();
        }
        $this->formFieldParser = $formFieldParser;
 
        if (null === $importAction) {
            $importAction = new ilCertificateTemplateImportAction(
                (int) $objectId,
                $certificatePath,
                $placeholderDescriptionObject,
                $logger,
                $DIC->filesystem()->web()
            );
        }
        $this->importAction = $importAction;
 
        if (null === $templateRepository) {
            $templateRepository = new ilCertificateTemplateRepository($database, $logger);
        }
        $this->templateRepository = $templateRepository;
 
        if (null === $filesystem) {
            $filesystem = $DIC->filesystem()->web();
        }
 
        if (null === $backgroundImageFileService) {
            $backgroundImageFileService = new ilCertificateBackgroundImageFileService(
                $certificatePath,
                $filesystem
            );
        }
        $this->backGroundImageFileService = $backgroundImageFileService;
    }

References $access, $certificatePath, $controller, $DIC, $formFieldParser, $hasAdditionalElements, $importAction, $language, $objectId, $pageFormats, $placeholderDescriptionObject, $templateRepository, $toolbar, and language().

Here is the call graph for this function:

Member Function Documentation

createForm()

ilCertificateSettingsFormRepository::createForm

(

ilCertificateGUI

$certificateGUI

)

Parameters

ilCertificateGUI	$certificateGUI
ilCertificate	$certificateObject
string	$certificatePath

Returns

ilPropertyFormGUI

Exceptions

ILIAS\Filesystem\Exception\FileAlreadyExistsException

Exceptions

ILIAS\Filesystem\Exception\FileNotFoundException

Exceptions

ILIAS\Filesystem\Exception\IOException

Exceptions

ilDatabaseException
ilException
ilWACException

Implements ilCertificateFormRepository.

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

    {
        $certificateTemplate = $this->templateRepository->fetchCurrentlyUsedCertificate($this->objectId);
 
        $command = $this->controller->getCmd();
 
        $form = new ilPropertyFormGUI();
        $form->setPreventDoubleSubmission(false);
        $form->setFormAction($this->controller->getFormAction($certificateGUI));
        $form->setTitle($this->language->txt("cert_form_sec_availability"));
        $form->setMultipart(true);
        $form->setTableWidth("100%");
        $form->setId("certificate");
 
        $active = new ilCheckboxInputGUI($this->language->txt("active"), "active");
        $form->addItem($active);
 
        $import = new ilFileInputGUI($this->language->txt("import"), "certificate_import");
        $import->setRequired(false);
        $import->setSuffixes(array("zip"));
 
        // handle the certificate import
        if (strlen($_FILES["certificate_import"]["name"])) {
            if ($import->checkInput()) {
                $result = $this->importAction->import($_FILES["certificate_import"]["tmp_name"], $_FILES["certificate_import"]["name"]);
                if ($result == false) {
                    $import->setAlert($this->language->txt("certificate_error_import"));
                } else {
                    $this->controller->redirect($certificateGUI, "certificateEditor");
                }
            }
        }
        $form->addItem($import);
 
        $formSection = new \ilFormSectionHeaderGUI();
        $formSection->setTitle($this->language->txt("cert_form_sec_layout"));
        $form->addItem($formSection);
 
        $pageformat = new ilRadioGroupInputGUI($this->language->txt("certificate_page_format"), "pageformat");
        $pageformats = $this->pageFormats->fetchPageFormats();
 
        foreach ($pageformats as $format) {
            $option = new ilRadioOption($format["name"], $format["value"]);
 
            if (strcmp($format["value"], "custom") == 0) {
                $pageheight = new ilTextInputGUI($this->language->txt("certificate_pageheight"), "pageheight");
                $pageheight->setSize(6);
                $pageheight->setValidationRegexp('/^(([1-9]+|([1-9]+[0]*[\.,]{0,1}[\d]+))|(0[\.,](0*[1-9]+[\d]*)))(cm|mm|in|pt|pc|px|em)$/is');
                $pageheight->setInfo($this->language->txt("certificate_unit_description"));
                $pageheight->setRequired(true);
                $option->addSubitem($pageheight);
 
                $pagewidth = new ilTextInputGUI($this->language->txt("certificate_pagewidth"), "pagewidth");
                $pagewidth->setSize(6);
                $pagewidth->setValidationRegexp('/^(([1-9]+|([1-9]+[0]*[\.,]{0,1}[\d]+))|(0[\.,](0*[1-9]+[\d]*)))(cm|mm|in|pt|pc|px|em)$/is');
                $pagewidth->setInfo($this->language->txt("certificate_unit_description"));
                $pagewidth->setRequired(true);
                $option->addSubitem($pagewidth);
            }
 
            $pageformat->addOption($option);
        }
 
        $pageformat->setRequired(true);
 
        if (strcmp($command, "certificateSave") == 0) {
            $pageformat->checkInput();
        }
 
        $form->addItem($pageformat);
 
        $bgimage = new ilImageFileInputGUI($this->language->txt("certificate_background_image"), "background");
        $bgimage->setRequired(false);
        $bgimage->setUseCache(false);
 
        $bgimage->setALlowDeletion(true);
        if (!$this->backGroundImageFileService->hasBackgroundImage($certificateTemplate)) {
            if ($this->globalCertificateSettings->hasBackgroundImage()) {
                ilWACSignedPath::setTokenMaxLifetimeInSeconds(15);
                $imagePath = ilWACSignedPath::signFile($this->globalCertificateSettings->getBackgroundImageThumbPathWeb());
                $bgimage->setImage($imagePath);
                $bgimage->setALlowDeletion(false);
            }
        } else {
            ilWACSignedPath::setTokenMaxLifetimeInSeconds(15);
 
            $thumbnailPath = $this->backGroundImageFileService->getBackgroundImageThumbPath();
 
            if (!is_file($thumbnailPath)) {
                //Trying if it uses default image path
                $thumbnailPath = CLIENT_WEB_DIR . $certificateTemplate->getBackgroundImagePath() . '.thumb.jpg';
                if (!is_file($thumbnailPath)) {
                    //Trying to use global default image
                    $thumbnailPath = $this->globalCertificateSettings->getDefaultBackgroundImageThumbPath();
                    if (!is_file($thumbnailPath)) {
                        //No image global default configured
                        $thumbnailPath = '';
                    }
                }
                $bgimage->setALlowDeletion(false);
            }
            $imagePath = ilWACSignedPath::signFile($thumbnailPath);
            $bgimage->setImage($imagePath);
        }
 
        $form->addItem($bgimage);
 
        $thumbnailImage = new ilImageFileInputGUI($this->language->txt('certificate_card_thumbnail_image'), 'certificate_card_thumbnail_image');
        $thumbnailImage->setRequired(false);
        $thumbnailImage->setUseCache(false);
        $thumbnailImage->setSuffixes(array('svg'));
 
        $allowThumbnailDeletion = false;
 
        $cardThumbnailImagePath = $certificateTemplate->getThumbnailImagePath();
        if ('' !== $cardThumbnailImagePath) {
            $presentationThumbnailImagePath = CLIENT_WEB_DIR . $cardThumbnailImagePath;
            $thumbnailImage->setImage(ilWACSignedPath::signFile($presentationThumbnailImagePath));
            $allowThumbnailDeletion = true;
        }
 
        $thumbnailImage->setAllowDeletion($allowThumbnailDeletion);
 
        $form->addItem($thumbnailImage);
 
        $rect = new ilCSSRectInputGUI($this->language->txt("certificate_margin_body"), "margin_body");
        $rect->setRequired(true);
        $rect->setUseUnits(true);
        $rect->setInfo($this->language->txt("certificate_unit_description"));
 
        if (strcmp($command, "certificateSave") == 0) {
            $rect->checkInput();
        }
 
        $form->addItem($rect);
 
        $certificate = new ilTextAreaInputGUI($this->language->txt("certificate_text"), "certificate_text");
        $certificate->removePlugin('ilimgupload');
        $certificate->setRequired(true);
        $certificate->setRows(20);
        $certificate->setCols(80);
 
        $placeholderHtmlDescription = $this->placeholderDescriptionObject->createPlaceholderHtmlDescription();
 
        $placeholderDescriptionInHtml = $placeholderHtmlDescription;
 
        $certificate->setInfo($placeholderDescriptionInHtml);
 
        $certificate->setUseRte(true, '3.4.7');
 
        $tags = array(
            "br",
            "em",
            "font",
            "li",
            "ol",
            "p",
            "span",
            "strong",
            "u",
            "ul"
        );
 
        $certificate->setRteTags($tags);
 
        if (strcmp($command, "certificateSave") == 0) {
            $certificate->checkInput();
        }
 
        $form->addItem($certificate);
 
        if (true === $this->hasAdditionalElements) {
            $formSection = new \ilFormSectionHeaderGUI();
            $formSection->setTitle($this->language->txt("cert_form_sec_add_features"));
            $form->addItem($formSection);
        }
 
        if ($this->access->checkAccess("write", "", $_GET["ref_id"])) {
            if ($certificateTemplate->isCurrentlyActive()) {
                $this->toolbar->setFormAction($this->controller->getFormAction($certificateGUI));
 
                $preview = ilSubmitButton::getInstance();
                $preview->setCaption('certificate_preview');
                $preview->setCommand('certificatePreview');
                $this->toolbar->addStickyItem($preview);
 
                $export = ilSubmitButton::getInstance();
                $export->setCaption('certificate_export');
                $export->setCommand('certificateExportFO');
                $this->toolbar->addButtonInstance($export);
 
                $delete = ilSubmitButton::getInstance();
                $delete->setCaption('delete');
                $delete->setCommand('certificateDelete');
                $this->toolbar->addButtonInstance($delete);
            }
            $form->addCommandButton("certificateSave", $this->language->txt("save"));
        }
 
        return $form;
    }

References $_GET, $format, $preview, $result, CLIENT_WEB_DIR, ilSubmitButton\getInstance(), language(), ilWACSignedPath\setTokenMaxLifetimeInSeconds(), and ilWACSignedPath\signFile().

Here is the call graph for this function:

fetchFormFieldData()

ilCertificateSettingsFormRepository::fetchFormFieldData

(

string

$content

)

Parameters

string

$content

Returns

array|mixed

Implements ilCertificateFormRepository.

Definition at line 393 of file class.ilCertificateSettingsFormRepository.php.

    {
        return $this->formFieldParser->fetchDefaultFormFields($content);
    }

save()

ilCertificateSettingsFormRepository::save

(

array

$formFields

)

Parameters

array

$formFields

Returns

mixed|void

Implements ilCertificateFormRepository.

Definition at line 385 of file class.ilCertificateSettingsFormRepository.php.

    {
    }

Field Documentation

$access

ilCertificateSettingsFormRepository::$access

private

Definition at line 27 of file class.ilCertificateSettingsFormRepository.php.

Referenced by __construct().

$backGroundImageFileService

ilCertificateSettingsFormRepository::$backGroundImageFileService

private

Definition at line 72 of file class.ilCertificateSettingsFormRepository.php.

$certificatePath

ilCertificateSettingsFormRepository::$certificatePath

private

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

Referenced by __construct().

$controller

ilCertificateSettingsFormRepository::$controller

private

Definition at line 22 of file class.ilCertificateSettingsFormRepository.php.

Referenced by __construct().

$formFieldParser

ilCertificateSettingsFormRepository::$formFieldParser

private

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

Referenced by __construct().

$globalCertificateSettings

ilCertificateSettingsFormRepository::$globalCertificateSettings

private

Definition at line 76 of file class.ilCertificateSettingsFormRepository.php.

$hasAdditionalElements

ilCertificateSettingsFormRepository::$hasAdditionalElements

private

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

Referenced by __construct().

$importAction

ilCertificateSettingsFormRepository::$importAction

private

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

Referenced by __construct().

$language

ilCertificateSettingsFormRepository::$language

private

Definition at line 17 of file class.ilCertificateSettingsFormRepository.php.

Referenced by __construct().

$objectId

ilCertificateSettingsFormRepository::$objectId

private

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

Referenced by __construct().

$pageFormats

ilCertificateSettingsFormRepository::$pageFormats

private

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

Referenced by __construct().

$placeholderDescriptionObject

ilCertificateSettingsFormRepository::$placeholderDescriptionObject

private

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

Referenced by __construct().

$templateRepository

ilCertificateSettingsFormRepository::$templateRepository

private

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

Referenced by __construct().

$toolbar

ilCertificateSettingsFormRepository::$toolbar

private

Definition at line 32 of file class.ilCertificateSettingsFormRepository.php.

Referenced by __construct().

---

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

• Services/Certificate/classes/Form/Repository/class.ilCertificateSettingsFormRepository.php