Inheritance diagram for ilCertificateSettingsCourseFormRepository:

Collaboration diagram for ilCertificateSettingsCourseFormRepository:

Public Member Functions
	__construct (\ilObject $object, string $certificatePath, ilLanguage $language, ilTemplate $template, ilCtrl $controller, ilAccess $access, ilToolbarGUI $toolbar, ilCertificatePlaceholderDescription $placeholderDescriptionObject, ilObjectLP $learningProgressObject=null, ilCertificateSettingsFormRepository $settingsFromFactory=null, ilCertificateObjUserTrackingHelper $trackingHelper=null, ilCertificateObjectHelper $objectHelper=null, ilCertificateObjectLPHelper $lpHelper=null, ilTree $tree=null, ilSetting $setting=null)

	createForm (ilCertificateGUI $certificateGUI, ilCertificate $certificateObject)

	save (array $formFields)

	fetchFormFieldData (string $content)

Private Member Functions
	getLPTypes (int $a_parent_ref_id)

	getInvalidLPModes ()

Private Attributes
	$language

	$settingsFromFactory

	$object

	$learningProgressObject

	$trackingHelper

	$objectHelper

	$lpHelper

	$tree

	$setting

Detailed Description

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

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

Constructor & Destructor Documentation

◆ __construct()

ilCertificateSettingsCourseFormRepository::__construct	(	\ilObject	$object,
		string	$certificatePath,
		ilLanguage	$language,
		ilTemplate	$template,
		ilCtrl	$controller,
		ilAccess	$access,
		ilToolbarGUI	$toolbar,
		ilCertificatePlaceholderDescription	$placeholderDescriptionObject,
		ilObjectLP	$learningProgressObject = `null`,
		ilCertificateSettingsFormRepository	$settingsFromFactory = `null`,
		ilCertificateObjUserTrackingHelper	$trackingHelper = `null`,
		ilCertificateObjectHelper	$objectHelper = `null`,
		ilCertificateObjectLPHelper	$lpHelper = `null`,
		ilTree	$tree = `null`,
		ilSetting	$setting = `null`
	)

Parameters

ilObject	$object
string	$certificatePath
ilLanguage	$language
ilTemplate	$template
ilCtrl	$controller
ilAccess	$access
ilToolbarGUI	$toolbar
ilCertificatePlaceholderDescription	$placeholderDescriptionObject
ilObjectLP \| null	$learningProgressObject
ilCertificateSettingsFormRepository \| null	$settingsFromFactory
ilCertificateObjUserTrackingHelper \| null	$trackingHelper
ilCertificateObjectHelper \| null	$objectHelper
ilCertificateObjectLPHelper \| null	$lpHelper
ilTree \| null	$tree
ilSetting \| null	$setting

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

References $DIC, $language, $learningProgressObject, $lpHelper, $object, $objectHelper, $setting, $settingsFromFactory, $template, $trackingHelper, $tree, ilObject\getId(), and ilObjectLP\getInstance().

       {
         $this->object = $object;
 
         $this->language = $language;
 
         if (null === $settingsFromFactory) {
             $settingsFromFactory = new ilCertificateSettingsFormRepository(
                 $object->getId(),
                 $certificatePath,
                 $language,
                 $template,
                 $controller,
                 $access,
                 $toolbar,
                 $placeholderDescriptionObject
             );
         }
         $this->settingsFromFactory = $settingsFromFactory;
 
         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,
		ilCertificate	$certificateObject
	)

Parameters

ilCertificateGUI	$certificateGUI
ilCertificate	$certificateObject

Returns: ilPropertyFormGUI

Exceptions

Implements ilCertificateFormRepository.

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

References $form, $id, $lpHelper, $objectHelper, getInvalidLPModes(), getLPTypes(), ilLPObjSettings\getMode(), ilLPObjSettings\LP_MODE_DEACTIVATED, and ilFormPropertyGUI\setTitle().

     {
         $form = $this->settingsFromFactory->createForm($certificateGUI, $certificateObject);
 
         $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->getId()));
 
             $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)) {
                     $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 )

Parameters

string $content

Returns: array|mixed

Implements ilCertificateFormRepository.

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

     {
         $formFields = $this->settingsFromFactory->fetchFormFieldData($content);
 
         $formFields['subitems'] = json_decode($this->setting->get('cert_subitems_' . $this->object->getId(), json_encode(array())));
         if ($formFields['subitems'] === 'null' || $formFields['subitems'] === null) {
             $formFields['subitems'] = array();
         }
         return $formFields;
     }

◆ getInvalidLPModes()

ilCertificateSettingsCourseFormRepository::getInvalidLPModes ( )

private

Returns: array

Definition at line 270 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().

     {
         $invalid_modes = array(
             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:

◆ getLPTypes()

ilCertificateSettingsCourseFormRepository::getLPTypes ( int $a_parent_ref_id )

private

Parameters

int $a_parent_ref_id

Returns: array

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

References $result, and $root.

Referenced by createForm().

                                                       : array
     {
         $result = array();
 
         $root = $this->tree->getNodeData($a_parent_ref_id);
         $sub_items = $this->tree->getSubTree($root);
         array_shift($sub_items); // remove root
 
         foreach ($sub_items as $node) {
             if ($this->lpHelper->isSupportedObjectType($node['type'])) {
                 $class = $this->lpHelper->getTypeClass($node['type']);
                 $modes = $class::getDefaultModes($this->trackingHelper->enabledLearningProgress());
 
                 if (sizeof($modes) > 1) {
                     $result[] = $node['type'];
                 }
             }
         }
 
         return $result;
     }

Here is the caller graph for this function:

◆ save()

ilCertificateSettingsCourseFormRepository::save ( array $formFields )

Parameters

array $formFields

Implements ilCertificateFormRepository.

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

References $learningProgressObject, $message, and getInvalidLPModes().

     {
         $invalidModes = $this->getInvalidLPModes();
 
         $titlesOfObjectsWithInvalidModes = array();
         $refIds = array();
         if (isset($formFields['subitems'])) {
             $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)) {
                 $titlesOfObjectsWithInvalidModes[] = $this->objectHelper->lookupTitle($objectId);
             }
         }
 
         if (sizeof($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']));
     }