ILIAS\Course\Certificate\CertificateSettingsCourseFormRepository Class Reference

Inheritance diagram for ILIAS\Course\Certificate\CertificateSettingsCourseFormRepository:

Collaboration diagram for ILIAS\Course\Certificate\CertificateSettingsCourseFormRepository:

Public Member Functions
	__construct (private readonly ilObject $object, string $certificatePath, bool $hasAdditionalElements, private readonly ilLanguage $language, ilCtrlInterface $ctrl, ilAccess $access, ilToolbarGUI $toolbar, ilCertificatePlaceholderDescription $placeholderDescriptionObject, ?ilCertificateSettingsFormRepository $settingsFormFactory=null, private readonly ilCertificateObjUserTrackingHelper $trackingHelper=new ilCertificateObjUserTrackingHelper(), private readonly ilCertificateObjectHelper $objectHelper=new ilCertificateObjectHelper(), private readonly ilCertificateObjectLPHelper $lpHelper=new ilCertificateObjectLPHelper(), ?ilTree $tree=null, private readonly ilSetting $setting=new ilSetting('crs'))
	createForm (ilCertificateGUI $certificateGUI)
	save (array $formFields)
	fetchFormFieldData (string $content)

Private Member Functions
	getInvalidLPModes ()

Private Attributes
readonly ilCertificateSettingsFormRepository	$settingsFormFactory
readonly ilTree	$tree

Detailed Description

Author

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

Definition at line 52 of file CertificateSettingsCourseFormRepository.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Course\Certificate\CertificateSettingsCourseFormRepository::__construct	(	private readonly ilObject	$object,
		string	$certificatePath,
		bool	$hasAdditionalElements,
		private readonly ilLanguage	$language,
		ilCtrlInterface	$ctrl,
		ilAccess	$access,
		ilToolbarGUI	$toolbar,
		ilCertificatePlaceholderDescription	$placeholderDescriptionObject,
		?ilCertificateSettingsFormRepository	$settingsFormFactory = null,
		private readonly ilCertificateObjUserTrackingHelper	$trackingHelper = new ilCertificateObjUserTrackingHelper(),
		private readonly ilCertificateObjectHelper	$objectHelper = new ilCertificateObjectHelper(),
		private readonly ilCertificateObjectLPHelper	$lpHelper = new ilCertificateObjectLPHelper(),
		?ilTree	$tree = null,
		private readonly ilSetting	$setting = new ilSetting('crs')
	)

Definition at line 57 of file CertificateSettingsCourseFormRepository.php.

References $DIC.

      {
        global $DIC;

        $this->settingsFormFactory = $settingsFormFactory ?? new ilCertificateSettingsFormRepository(
            $object->getId(),
            $certificatePath,
            $hasAdditionalElements,
            $language,
            $ctrl,
            $access,
            $toolbar,
            $placeholderDescriptionObject,
            $DIC->ui()->factory(),
            $DIC->ui()->renderer()
        );
        $this->tree = $tree ?? $DIC->repositoryTree();
    }

Member Function Documentation

createForm()

ILIAS\Course\Certificate\CertificateSettingsCourseFormRepository::createForm

(

ilCertificateGUI

$certificateGUI

)

Exceptions

FileAlreadyExistsException
FileNotFoundException
IOException
ilDatabaseException
ilException
ilWACException

Implements ilCertificateFormRepository.

Definition at line 98 of file CertificateSettingsCourseFormRepository.php.

References $id, ILIAS\Course\Certificate\CertificateSettingsCourseFormRepository\getInvalidLPModes(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), ilLPObjSettings\LP_MODE_DEACTIVATED, null, ILIAS\Repository\object(), and ilFormPropertyGUI\setTitle().

                                                                : ilPropertyFormGUI
    {
        $form = $this->settingsFormFactory->createForm($certificateGUI);

        $objectLearningProgressSettings = new ilLPObjSettings($this->object->getId());

        $mode = $objectLearningProgressSettings->getMode();
        if (!$this->trackingHelper->enabledLearningProgress() || $mode === ilLPObjSettings::LP_MODE_DEACTIVATED) {
            $subitems = new ilRepositorySelector2InputGUI($this->language->txt('objects'), 'subitems', true);

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

            $exp = $subitems->getExplorerGUI();
            $exp->setSkipRootNode(true);
            $exp->setRootId($this->object->getRefId());
            $exp->setTypeWhiteList($this->getLPTypes($this->object->getRefId()));

            $objectHelper = $this->objectHelper;
            $lpHelper = $this->lpHelper;
            $subitems->setTitleModifier(function ($id) use ($objectHelper, $lpHelper): string {
                if (null === $id) {
                    return '';
                }
                $obj_id = $objectHelper->lookupObjId((int) $id);
                $olp = $lpHelper->getInstance($obj_id);

                $invalid_modes = $this->getInvalidLPModes();

                $mode = $olp->getModeText($olp->getCurrentMode());

                if (in_array($olp->getCurrentMode(), $invalid_modes, true)) {
                    $mode = '<strong>' . $mode . '</strong>';
                }

                return $objectHelper->lookupTitle($obj_id) . ' (' . $mode . ')';
            });

            $subitems->setRequired(true);
            $form->addItem($subitems);
        }

        return $form;
    }

Here is the call graph for this function:

fetchFormFieldData()

ILIAS\Course\Certificate\CertificateSettingsCourseFormRepository::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, subitems: mixed}

Implements ilCertificateFormRepository.

Definition at line 181 of file CertificateSettingsCourseFormRepository.php.

References null.

                                                       : array
    {
        $formFields = $this->settingsFormFactory->fetchFormFieldData($content);

        $formFields['subitems'] = json_decode($this->setting->get(
            'cert_subitems_' . $this->object->getId(),
            json_encode([], JSON_THROW_ON_ERROR)
        ), true, 512, JSON_THROW_ON_ERROR);
        if ($formFields['subitems'] === 'null' || $formFields['subitems'] === null) {
            $formFields['subitems'] = [];
        }

        return $formFields;
    }

getInvalidLPModes()

ILIAS\Course\Certificate\CertificateSettingsCourseFormRepository::getInvalidLPModes ( )

private

Returns

int[]

Definition at line 225 of file CertificateSettingsCourseFormRepository.php.

References ilLPObjSettings\LP_MODE_COLLECTION, ilLPObjSettings\LP_MODE_COLLECTION_MANUAL, ilLPObjSettings\LP_MODE_COLLECTION_MOBS, ilLPObjSettings\LP_MODE_COLLECTION_TLT, ilLPObjSettings\LP_MODE_DEACTIVATED, ilLPObjSettings\LP_MODE_MANUAL_BY_TUTOR, ilLPObjSettings\LP_MODE_SCORM, ilLPObjSettings\LP_MODE_UNDEFINED, and ilLPObjSettings\LP_MODE_VISITS.

Referenced by ILIAS\Course\Certificate\CertificateSettingsCourseFormRepository\createForm(), and ILIAS\Course\Certificate\CertificateSettingsCourseFormRepository\save().

                                        : array
    {
        $invalid_modes = [
            ilLPObjSettings::LP_MODE_DEACTIVATED,
            ilLPObjSettings::LP_MODE_UNDEFINED
        ];

        // without active LP the following modes cannot be supported
        if (!$this->trackingHelper->enabledLearningProgress()) {
            // status cannot be set without active LP
            //$invalid_modes[] = ilLPObjSettings::LP_MODE_MANUAL;
            $invalid_modes[] = ilLPObjSettings::LP_MODE_MANUAL_BY_TUTOR;
            $invalid_modes[] = ilLPObjSettings::LP_MODE_COLLECTION_MANUAL;

            // mode cannot be configured without active LP
            $invalid_modes[] = ilLPObjSettings::LP_MODE_COLLECTION;
            $invalid_modes[] = ilLPObjSettings::LP_MODE_COLLECTION_MOBS;
            $invalid_modes[] = ilLPObjSettings::LP_MODE_COLLECTION_TLT;
            $invalid_modes[] = ilLPObjSettings::LP_MODE_SCORM;
            $invalid_modes[] = ilLPObjSettings::LP_MODE_VISITS; // ?
        }

        return $invalid_modes;
    }

Here is the caller graph for this function:

save()

ILIAS\Course\Certificate\CertificateSettingsCourseFormRepository::save

(

array

$formFields

)

Exceptions

ilException

Implements ilCertificateFormRepository.

Definition at line 147 of file CertificateSettingsCourseFormRepository.php.

References $message, $refId, ILIAS\Course\Certificate\CertificateSettingsCourseFormRepository\getInvalidLPModes(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\Repository\object().

                                           : void
    {
        $invalidModes = $this->getInvalidLPModes();

        $titlesOfObjectsWithInvalidModes = [];
        $refIds = $formFields['subitems'] ?? [];

        foreach ($refIds as $refId) {
            $objectId = $this->objectHelper->lookupObjId((int) $refId);
            $learningProgressObject = $this->lpHelper->getInstance($objectId);
            $currentMode = $learningProgressObject->getCurrentMode();
            if (in_array($currentMode, $invalidModes, true)) {
                $titlesOfObjectsWithInvalidModes[] = $this->objectHelper->lookupTitle($objectId);
            }
        }

        if ($titlesOfObjectsWithInvalidModes !== []) {
            $message = sprintf(
                $this->language->txt('certificate_learning_progress_must_be_active'),
                implode(', ', $titlesOfObjectsWithInvalidModes)
            );

            throw new ilException($message);
        }

        $this->setting->set(
            'cert_subitems_' . $this->object->getId(),
            json_encode($formFields['subitems'] ?? [], JSON_THROW_ON_ERROR)
        );
    }

Here is the call graph for this function:

Field Documentation

$settingsFormFactory

readonly ilCertificateSettingsFormRepository ILIAS\Course\Certificate\CertificateSettingsCourseFormRepository::$settingsFormFactory

private

Definition at line 54 of file CertificateSettingsCourseFormRepository.php.

$tree

readonly ilTree ILIAS\Course\Certificate\CertificateSettingsCourseFormRepository::$tree

private

Definition at line 55 of file CertificateSettingsCourseFormRepository.php.

---

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

• components/ILIAS/Course/classes/Certificate/CertificateSettingsCourseFormRepository.php