This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilOrgUnitGlobalSettings:

Public Member Functions
	getObjectPositionSettingsByType (string $a_obj_type)

	isPositionAccessActiveForObject (int $a_obj_id)
	Check of position access is activate for object. More...

	saveDefaultPositionActivationStatus (int $a_obj_id)
	Set and save the default activation status according to settings. More...

	getPositionSettings ()

Static Public Member Functions
static	getInstance ()

Protected Attributes
ilObjectDefinition	$object_definition = null

Private Member Functions
	__construct ()

	readSettings ()

Private Attributes
array	$position_settings = []

array	$object_position_cache = []
	Array with key obj_id => active status. More...

Static Private Attributes
static ilOrgUnitGlobalSettings	$instance = null

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Global settings for org units

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 25 of file class.ilOrgUnitGlobalSettings.php.

Constructor & Destructor Documentation

◆ __construct()

ilOrgUnitGlobalSettings::__construct ( )

private

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

References $GLOBALS, and readSettings().

     {
         $this->object_definition = $GLOBALS['DIC']['objDefinition'];
         $this->readSettings();
     }

Here is the call graph for this function:

Member Function Documentation

◆ getInstance()

static ilOrgUnitGlobalSettings::getInstance ( )

static

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

Referenced by ilOrgUnitPositionAccess\__construct(), ilObjEmployeeTalkAccess\__construct(), ilPermission2GUI\__initSubTabs(), ilStudyProgrammeDIC\buildDIC(), ilObjTestSettingsGeneralGUI\buildForm(), ilOrgUnitPermissionTableGUI\collectData(), ilObject\create(), ilOrgUnitPermissionQueries\getAllTemplateSetsForAllActivedContexts(), ilObjExerciseGUI\getEditFormCustomValues(), ilOrgUnitPermissionQueries\hasLocalSet(), ilObjectServiceSettingsGUI\initServiceSettingsForm(), ilObjExerciseGUI\listAssignmentsObject(), ilObjExercise\saveData(), ilStudyProgrammeDIC\specificDicFor(), ilObjectServiceSettingsGUI\updateServiceSettingsForm(), and ILIAS\Survey\Settings\SettingsFormGUI\withOther().

                                         : self
     {
         if (!self::$instance) {
             self::$instance = new self();
         }
 
         return self::$instance;
     }

Here is the caller graph for this function:

◆ getObjectPositionSettingsByType()

ilOrgUnitGlobalSettings::getObjectPositionSettingsByType ( string $a_obj_type )

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

Referenced by isPositionAccessActiveForObject(), and saveDefaultPositionActivationStatus().

                                                                        : ilOrgUnitObjectTypePositionSetting
     {
         if (!isset($this->position_settings[$a_obj_type])) {
             throw new \InvalidArgumentException('Object type passed does not support position settings: '
                 . $a_obj_type);
         }
 
         return $this->position_settings[$a_obj_type];
     }

Here is the caller graph for this function:

◆ getPositionSettings()

ilOrgUnitGlobalSettings::getPositionSettings ( )

Returns: ilOrgUnitObjectTypePositionSetting[]

Definition at line 129 of file class.ilOrgUnitGlobalSettings.php.

References $position_settings.

                                          : array
     {
         return $this->position_settings;
     }

◆ isPositionAccessActiveForObject()

ilOrgUnitGlobalSettings::isPositionAccessActiveForObject ( int $a_obj_id )

Check of position access is activate for object.

Definition at line 65 of file class.ilOrgUnitGlobalSettings.php.

References $type, ilObject\_lookupType(), and getObjectPositionSettingsByType().

                                                                   : bool
     {
         if (isset($this->object_position_cache[$a_obj_id])) {
             return $this->object_position_cache[$a_obj_id];
         }
         $type = ilObject::_lookupType($a_obj_id);
         try {
             $type_settings = $this->getObjectPositionSettingsByType($type);
         } catch (\InvalidArgumentException $invalid_type_exception) {
             $this->object_position_cache[$a_obj_id] = false;
 
             return false;
         }
 
         if (!$type_settings->isActive()) {
             $this->object_position_cache[$a_obj_id] = false;
 
             return false;
         }
         if (!$type_settings->isChangeableForObject()) {
             $this->object_position_cache[$a_obj_id] = true;
 
             return true;
         }
         $object_position = new ilOrgUnitObjectPositionSetting($a_obj_id);
 
         if ($object_position->hasObjectSpecificActivation()) {
             $this->object_position_cache[$a_obj_id] = $object_position->isActive();
         } else {
             $this->object_position_cache[$a_obj_id] = (bool) $type_settings->getActivationDefault();
         }
 
         return $this->object_position_cache[$a_obj_id];
     }

Here is the call graph for this function:

◆ readSettings()

ilOrgUnitGlobalSettings::readSettings ( )

private

Definition at line 119 of file class.ilOrgUnitGlobalSettings.php.

References $type.

Referenced by __construct().

                                    : void
     {
         foreach ($this->object_definition->getOrgUnitPermissionTypes() as $type) {
             $this->position_settings[$type] = new ilOrgUnitObjectTypePositionSetting($type);
         }
     }

Here is the caller graph for this function:

◆ saveDefaultPositionActivationStatus()

ilOrgUnitGlobalSettings::saveDefaultPositionActivationStatus ( int $a_obj_id )

Set and save the default activation status according to settings.

Parameters

int $a_obj_id

Definition at line 104 of file class.ilOrgUnitGlobalSettings.php.

References $type, ilObject\_lookupType(), and getObjectPositionSettingsByType().

                                                                       : void
     {
         $type = ilObject::_lookupType($a_obj_id);
         try {
             $type_settings = $this->getObjectPositionSettingsByType($type);
         } catch (\InvalidArgumentException $ex) {
             return;
         }
         if ($type_settings->isActive()) {
             $object_setting = new ilOrgUnitObjectTypePositionSetting($a_obj_id);
             $object_setting->setActive($type_settings->getActivationDefault());
             $object_setting->update();
         }
     }