Global settings for org units. More...

Collaboration diagram for ilOrgUnitGlobalSettings:

Public Member Functions
	getObjectPositionSettingsByType ($a_obj_type)
	Get object position settings by type. More...

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

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

	getPositionSettings ()

Static Public Member Functions
static	getInstance ()
	Get instance. More...

Protected Member Functions
	__construct ()
	Singelton constructor. More...

	readSettings ()
	read settings More...

Protected Attributes
	$object_definition = null

Private Attributes
	$position_settings = []

	$object_position_cache = []

Static Private Attributes
static	$instance = null

Detailed Description

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 11 of file class.ilOrgUnitGlobalSettings.php.

Constructor & Destructor Documentation

◆ __construct()

ilOrgUnitGlobalSettings::__construct ( )

protected

Singelton constructor.

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

Get instance.

Returns: ilOrgUnitGlobalSettings

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

Referenced by ilOrgUnitPositionAccess\__construct(), ilPermission2GUI\__initSubTabs(), ilObjTestSettingsGeneralGUI\buildForm(), ilOrgUnitPermissionTableGUI\collectData(), ilObject\create(), ilIndividualAssessmentSettingsGUI\fillForm(), ilIndividualAssessmentAccessHandler\filterViewableOrGradeableUsers(), ilOrgUnitPermissionQueries\getAllTemplateSetsForAllActivedContexts(), ilObjExerciseGUI\getEditFormCustomValues(), ilOrgUnitPermissionQueries\hasLocalSet(), ilObjExerciseGUI\initEditCustomForm(), ilObjSurveyGUI\initPropertiesForm(), ilObjectServiceSettingsGUI\initServiceSettingsForm(), and ilObjectServiceSettingsGUI\updateServiceSettingsForm().

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

Here is the caller graph for this function:

◆ getObjectPositionSettingsByType()

ilOrgUnitGlobalSettings::getObjectPositionSettingsByType ( $a_obj_type )

Get object position settings by type.

Parameters

string $a_obj_type

Returns: ilOrgUnitObjectTypePositionSetting

Exceptions

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

Referenced by isPositionAccessActiveForObject(), and saveDefaultPositionActivationStatus().

     {
         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: []

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

References $position_settings.

     {
         return $this->position_settings;
     }

◆ isPositionAccessActiveForObject()

ilOrgUnitGlobalSettings::isPositionAccessActiveForObject ( $a_obj_id )

Check of position access is activate for object.

Parameters

int $a_obj_id

Returns: bool

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

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

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

protected

read settings

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

References $type.

Referenced by __construct().

     {
         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 ( $a_obj_id )

Set and save the default activation status according to settings.

Parameters

int $a_obj_id

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

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

     {
         $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();
         }
 
         return;
     }