ilOrgUnitGlobalSettings Class Reference

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

Constructor & Destructor Documentation

__construct()

ilOrgUnitGlobalSettings::__construct ( )

private

Definition at line 35 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 41 of file class.ilOrgUnitGlobalSettings.php.

Referenced by ilOrgUnitPositionAccess\__construct(), ilObjEmployeeTalkAccess\__construct(), ilPermissionGUI\__initSubTabs(), ilStudyProgrammeDIC\buildDIC(), ilOrgUnitPermissionTableGUI\collectData(), ilObject\create(), ilOrgUnitPermissionDBRepository\getDefaultsForActiveContexts(), ilObjExerciseGUI\getEditFormCustomValues(), ILIAS\Test\Settings\MainSettings\SettingsMainGUI\getOrganisationalUnitsActivationInput(), ilObjectServiceSettingsGUI\initServiceSettingsForm(), ilOrgUnitPermissionDBRepository\isContextEnabled(), ilObjExerciseGUI\listAssignmentsObject(), ilObjExercise\saveData(), ILIAS\Test\Settings\MainSettings\SettingsMainGUI\saveOrganisationalUnitsActivation(), 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 50 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 127 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 63 of file class.ilOrgUnitGlobalSettings.php.

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

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

References 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();
        }
    }

Here is the call graph for this function:

Field Documentation

$instance

ilOrgUnitGlobalSettings ilOrgUnitGlobalSettings::$instance = null

staticprivate

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

$object_definition

ilObjectDefinition ilOrgUnitGlobalSettings::$object_definition = null

protected

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

$object_position_cache

array ilOrgUnitGlobalSettings::$object_position_cache = []

private

Array with key obj_id => active status.

Parameters

bool[]

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

$position_settings

array ilOrgUnitGlobalSettings::$position_settings = []

private

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

Referenced by getPositionSettings().

---

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

• components/ILIAS/OrgUnit/classes/Settings/class.ilOrgUnitGlobalSettings.php