Inheritance diagram for ilCertificateSettingsCourseFormRepository:

Collaboration diagram for ilCertificateSettingsCourseFormRepository:

Public Member Functions
	__construct (ilObject $object, string $certificatePath, bool $hasAdditionalElements, ilLanguage $language, ilCtrlInterface $ctrl, ilAccess $access, ilToolbarGUI $toolbar, ilCertificatePlaceholderDescription $placeholderDescriptionObject, ?ilObjectLP $learningProgressObject=null, ?ilCertificateSettingsFormRepository $settingsFormFactory=null, ?ilCertificateObjUserTrackingHelper $trackingHelper=null, ?ilCertificateObjectHelper $objectHelper=null, ?ilCertificateObjectLPHelper $lpHelper=null, ?ilTree $tree=null, ?ilSetting $setting=null)

	createForm (ilCertificateGUI $certificateGUI)

	save (array $formFields)

	fetchFormFieldData (string $content)

Private Member Functions
	getInvalidLPModes ()

Private Attributes
ilLanguage	$language

ilCertificateSettingsFormRepository	$settingsFormFactory

ilObjCourse	$object

ilObjectLP	$learningProgressObject

ilCertificateObjUserTrackingHelper	$trackingHelper

ilCertificateObjectHelper	$objectHelper

ilCertificateObjectLPHelper	$lpHelper

ilTree	$tree

ilSetting	$setting

Detailed Description

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

Definition at line 28 of file class.ilCertificateSettingsCourseFormRepository.php.

Constructor & Destructor Documentation

◆ __construct()

ilCertificateSettingsCourseFormRepository::__construct	(	ilObject	$object,
		string	$certificatePath,
		bool	$hasAdditionalElements,
		ilLanguage	$language,
		ilCtrlInterface	$ctrl,
		ilAccess	$access,
		ilToolbarGUI	$toolbar,
		ilCertificatePlaceholderDescription	$placeholderDescriptionObject,
		?ilObjectLP	$learningProgressObject = `null`,
		?ilCertificateSettingsFormRepository	$settingsFormFactory = `null`,
		?ilCertificateObjUserTrackingHelper	$trackingHelper = `null`,
		?ilCertificateObjectHelper	$objectHelper = `null`,
		?ilCertificateObjectLPHelper	$lpHelper = `null`,
		?ilTree	$tree = `null`,
		?ilSetting	$setting = `null`
	)

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

References $DIC, $language, $learningProgressObject, $lpHelper, $object, $objectHelper, $setting, $settingsFormFactory, $trackingHelper, $tree, ilObject\getId(), ilObjectLP\getInstance(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\Repository\object().

       {
         $this->object = $object;
 
         $this->language = $language;
 
         if (null === $settingsFormFactory) {
             $settingsFormFactory = new ilCertificateSettingsFormRepository(
                 $object->getId(),
                 $certificatePath,
                 $hasAdditionalElements,
                 $language,
                 $ctrl,
                 $access,
                 $toolbar,
                 $placeholderDescriptionObject
             );
         }
         $this->settingsFormFactory = $settingsFormFactory;
 
         if (null === $learningProgressObject) {
             $learningProgressObject = ilObjectLP::getInstance($this->object->getId());
         }
         $this->learningProgressObject = $learningProgressObject;
 
         if (null === $trackingHelper) {
             $trackingHelper = new ilCertificateObjUserTrackingHelper();
         }
         $this->trackingHelper = $trackingHelper;
 
         if (null === $objectHelper) {
             $objectHelper = new ilCertificateObjectHelper();
         }
         $this->objectHelper = $objectHelper;
 
         if (null === $lpHelper) {
             $lpHelper = new ilCertificateObjectLPHelper();
         }
         $this->lpHelper = $lpHelper;
 
         if (null === $tree) {
             global $DIC;
             $tree = $DIC['tree'];
         }
         $this->tree = $tree;
 
         if (null === $setting) {
             $setting = new ilSetting('crs');
         }
         $this->setting = $setting;
     }

Here is the call graph for this function:

Member Function Documentation

◆ createForm()

ilCertificateSettingsCourseFormRepository::createForm ( ilCertificateGUI $certificateGUI )

Parameters

ilCertificateGUI $certificateGUI

Returns: ilPropertyFormGUI

Exceptions

FileAlreadyExistsException
FileNotFoundException
IOException
ilDatabaseException
ilException
ilWACException

Implements ilCertificateFormRepository.

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

References $id, $lpHelper, $objectHelper, ilCertificateObjectLPHelper\getInstance(), getInvalidLPModes(), ilLPObjSettings\getMode(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), ilCertificateObjectHelper\lookupObjId(), ilCertificateObjectHelper\lookupTitle(), ilLPObjSettings\LP_MODE_DEACTIVATED, 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) {
                 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()

ilCertificateSettingsCourseFormRepository::fetchFormFieldData ( string $content )

Implements ilCertificateFormRepository.

Definition at line 196 of file class.ilCertificateSettingsCourseFormRepository.php.

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

ilCertificateSettingsCourseFormRepository::getInvalidLPModes ( )

private

Returns: int[]

Definition at line 240 of file class.ilCertificateSettingsCourseFormRepository.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, ilLPObjSettings\LP_MODE_MANUAL_BY_TUTOR, ilLPObjSettings\LP_MODE_SCORM, ilLPObjSettings\LP_MODE_UNDEFINED, and ilLPObjSettings\LP_MODE_VISITS.

Referenced by createForm(), and 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()

ilCertificateSettingsCourseFormRepository::save ( array $formFields )

Parameters

array $formFields

Exceptions

ilException

Implements ilCertificateFormRepository.

Definition at line 166 of file class.ilCertificateSettingsCourseFormRepository.php.

References $message, $refId, ilObjectLP\getCurrentMode(), ilObjectLP\getInstance(), 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 (count($titlesOfObjectsWithInvalidModes) > 0) {
             $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)
         );
     }