ilCertificateSettingsFormRepository Class Reference

Inheritance diagram for ilCertificateSettingsFormRepository:

Collaboration diagram for ilCertificateSettingsFormRepository:

Public Member Functions
	__construct (private readonly int $objectId, string $certificatePath, private readonly bool $hasAdditionalElements, private readonly ilLanguage $language, private readonly ilCtrlInterface $ctrl, private readonly ilAccessHandler $access, private readonly ilToolbarGUI $toolbar, private readonly ilCertificatePlaceholderDescription $placeholderDescriptionObject, ?UiFactory $ui_factory=null, ?UiRenderer $ui_renderer=null, ?ilPageFormats $pageFormats=null, private readonly ilFormFieldParser $formFieldParser=new ilFormFieldParser(), ?ilCertificateTemplateImportAction $importAction=null, ?ilLogger $logger=null, ?ilCertificateTemplateRepository $templateRepository=null, ?Filesystem $filesystem=null, ?ilCertificateBackgroundImageFileService $backgroundImageFileService=null)
	createForm (ilCertificateGUI $certificateGUI)
	save (array $formFields)
	fetchFormFieldData (string $content)

Private Attributes
readonly UiFactory	$ui_factory
readonly UiRenderer	$ui_renderer
readonly ilPageFormats	$pageFormats
readonly ilCertificateTemplateImportAction	$importAction
readonly ilCertificateTemplateRepository	$templateRepository
readonly ilCertificateBackgroundImageFileService	$backGroundImageFileService
readonly WrapperFactory	$httpWrapper
readonly Refinery	$refinery
readonly ilObjCertificateSettings	$global_certificate_settings
readonly ilGlobalTemplateInterface	$page_template

Detailed Description

Author

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

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

Constructor & Destructor Documentation

__construct()

ilCertificateSettingsFormRepository::__construct	(	private readonly int	$objectId,
		string	$certificatePath,
		private readonly bool	$hasAdditionalElements,
		private readonly ilLanguage	$language,
		private readonly ilCtrlInterface	$ctrl,
		private readonly ilAccessHandler	$access,
		private readonly ilToolbarGUI	$toolbar,
		private readonly ilCertificatePlaceholderDescription	$placeholderDescriptionObject,
		?UiFactory	$ui_factory = null,
		?UiRenderer	$ui_renderer = null,
		?ilPageFormats	$pageFormats = null,
		private readonly ilFormFieldParser	$formFieldParser = new ilFormFieldParser(),
		?ilCertificateTemplateImportAction	$importAction = null,
		?ilLogger	$logger = null,
		?ilCertificateTemplateRepository	$templateRepository = null,
		?Filesystem	$filesystem = null,
		?ilCertificateBackgroundImageFileService	$backgroundImageFileService = null
	)

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

References $DIC, and ILIAS\Repository\refinery().

      {
        global $DIC;

        $this->httpWrapper = $DIC->http()->wrapper();
        $this->refinery = $DIC->refinery();
        $this->page_template = $DIC->ui()->mainTemplate();

        $this->ui_factory = $ui_factory ?? $DIC->ui()->factory();
        $this->ui_renderer = $ui_renderer ?? $DIC->ui()->renderer();
        $this->pageFormats = $pageFormats ?? new ilPageFormats($language);
        $this->importAction = $importAction ?? new ilCertificateTemplateImportAction(
            $objectId,
            $certificatePath,
            $placeholderDescriptionObject,
            ($logger ?? $DIC->logger()->cert()),
            $DIC->filesystem()->web()
        );
        $this->templateRepository = $templateRepository ?? new ilCertificateTemplateDatabaseRepository(
            $DIC->database(),
            ($logger ?? $DIC->logger()->cert())
        );
        $this->backGroundImageFileService = $backgroundImageFileService ?? new ilCertificateBackgroundImageFileService(
            $certificatePath,
            ($filesystem ?? $DIC->filesystem()->web())
        );

        $this->global_certificate_settings = new ilObjCertificateSettings();
    }

Here is the call graph for this function:

Member Function Documentation

createForm()

ilCertificateSettingsFormRepository::createForm

(

ilCertificateGUI

$certificateGUI

)

Exceptions

FileAlreadyExistsException
FileNotFoundException
IOException
ilDatabaseException
ilException
ilWACException

Implements ilCertificateFormRepository.

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

References ILIAS\Repository\access(), CLIENT_WEB_DIR, ILIAS\Repository\ctrl(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), ILIAS\Repository\refinery(), ilTextAreaInputGUI\removePlugin(), ilFormPropertyGUI\setRequired(), ilWACSignedPath\setTokenMaxLifetimeInSeconds(), ilWACSignedPath\signFile(), and ILIAS\Repository\toolbar().

                                                                : ilPropertyFormGUI
    {
        $certificateTemplate = $this->templateRepository->fetchCurrentlyUsedCertificate($this->objectId);

        $command = $this->ctrl->getCmd();

        $form = new ilPropertyFormGUI();
        $form->setPreventDoubleSubmission(false);
        $form->setFormAction($this->ctrl->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(['zip']);

        // handle the certificate import
        if (!empty($_FILES['certificate_import']['name']) && $import->checkInput()) {
            $result = $this->importAction->import(
                $_FILES['certificate_import']['tmp_name'],
                $_FILES['certificate_import']['name']
            );
            if ($result) {
                $this->page_template->setOnScreenMessage(
                    $this->page_template::MESSAGE_TYPE_SUCCESS,
                    $this->language->txt('saved_successfully'),
                    true
                );
                $this->ctrl->redirect($certificateGUI, 'certificateEditor');
            } else {
                $this->page_template->setOnScreenMessage(
                    $this->page_template::MESSAGE_TYPE_FAILURE,
                    $this->language->txt('certificate_error_import'),
                    true
                );
                $this->ctrl->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->global_certificate_settings->hasBackgroundImage()) {
                ilWACSignedPath::setTokenMaxLifetimeInSeconds(15);
                $imagePath = ilWACSignedPath::signFile($this->global_certificate_settings->getBackgroundImageThumbPathWeb());
                $bgimage->setImage($imagePath);
                $bgimage->setAllowDeletion(false);
            }
        } else {
            ilWACSignedPath::setTokenMaxLifetimeInSeconds(15);

            $thumbnail_path = $this->backGroundImageFileService->getBackgroundImageThumbPath();

            if (!is_file($thumbnail_path)) {
                //Trying if it uses default image path
                $thumbnail_path = CLIENT_WEB_DIR . $certificateTemplate->getBackgroundImagePath() . '.thumb.jpg';
                if (!is_file($thumbnail_path)) {
                    //Trying to use global default image
                    $thumbnail_path = $this->global_certificate_settings->getDefaultBackgroundImageThumbPath();
                    if (!is_file($thumbnail_path)) {
                        //No image global default configured
                        $thumbnail_path = '';
                    }
                }
                $bgimage->setALlowDeletion(false);
            }
            $imagePath = ilWACSignedPath::signFile($thumbnail_path);
            $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(['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);

        $certificate->setInfo(
            $this->language->txt('certificate_text_info') . $this->placeholderDescriptionObject->createPlaceholderHtmlDescription()
        );

        $certificate->setUseRte(true, '3.4.7');

        $tags = [
            'br',
            'em',
            'font',
            'li',
            'ol',
            'p',
            'span',
            'strong',
            'u',
            'ul'
        ];

        $certificate->setRteTags($tags);

        if (strcmp($command, 'certificateSave') === 0) {
            $certificate->checkInput();
        }

        $form->addItem($certificate);

        if ($this->hasAdditionalElements) {
            $formSection = new ilFormSectionHeaderGUI();
            $formSection->setTitle($this->language->txt('cert_form_sec_add_features'));
            $form->addItem($formSection);
        }

        if ($this->access->checkAccess(
            'write',
            '',
            $this->httpWrapper->query()->retrieve('ref_id', $this->refinery->kindlyTo()->int())
        )) {
            if ($certificateTemplate->isCurrentlyActive()) {
                $preview_button = $this->ui_factory->button()->standard(
                    $this->language->txt('certificate_preview'),
                    $this->ctrl->getLinkTarget($certificateGUI, 'certificatePreview')
                );
                $export_button = $this->ui_factory->button()->standard(
                    $this->language->txt('certificate_export'),
                    $this->ctrl->getLinkTarget($certificateGUI, 'certificateExportFO')
                );
                $delete_button = $this->ui_factory->button()->standard(
                    $this->language->txt('delete'),
                    $this->ctrl->getLinkTarget($certificateGUI, 'certificateDelete')
                );

                $this->toolbar->addStickyItem($preview_button);
                $this->toolbar->addComponent($export_button);
                $this->toolbar->addComponent($delete_button);
            }
            $form->addCommandButton("certificateSave", $this->language->txt("save"));
        }

        return $form;
    }

Here is the call graph for this function:

fetchFormFieldData()

ilCertificateSettingsFormRepository::fetchFormFieldData

(

string

$content

)

Returns

array{pageformat: string, pagewidth: mixed, pageheight: mixed, margin_body_top: mixed, margin_body_right: mixed, margin_body_bottom: mixed, margin_body_left: mixed, certificate_text: string}

Implements ilCertificateFormRepository.

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

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

save()

ilCertificateSettingsFormRepository::save

(

array

$formFields

)

Implements ilCertificateFormRepository.

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

                                           : void
    {
    }

Field Documentation

$backGroundImageFileService

readonly ilCertificateBackgroundImageFileService ilCertificateSettingsFormRepository::$backGroundImageFileService

private

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

$global_certificate_settings

readonly ilObjCertificateSettings ilCertificateSettingsFormRepository::$global_certificate_settings

private

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

$httpWrapper

readonly WrapperFactory ilCertificateSettingsFormRepository::$httpWrapper

private

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

$importAction

readonly ilCertificateTemplateImportAction ilCertificateSettingsFormRepository::$importAction

private

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

$page_template

readonly ilGlobalTemplateInterface ilCertificateSettingsFormRepository::$page_template

private

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

$pageFormats

readonly ilPageFormats ilCertificateSettingsFormRepository::$pageFormats

private

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

$refinery

readonly Refinery ilCertificateSettingsFormRepository::$refinery

private

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

$templateRepository

readonly ilCertificateTemplateRepository ilCertificateSettingsFormRepository::$templateRepository

private

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

$ui_factory

readonly UiFactory ilCertificateSettingsFormRepository::$ui_factory

private

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

$ui_renderer

readonly UiRenderer ilCertificateSettingsFormRepository::$ui_renderer

private

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

---

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

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