ilOrgUnitPermissionQueries 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 ilOrgUnitPermissionQueries:

Static Public Member Functions
static	getTemplateSetForContextName (string $context_name, string $position_id, bool $editable=false)
static	hasLocalSet (int $ref_id, int $position_id)
static	getAllTemplateSetsForAllActivedContexts (int $position_id, bool $editable=false)

Static Private Member Functions
static	getContextByRefId (int $ref_id)
static	assertRefIdAndPositionIdIsNotNull (int $ref_id, int $position_id)

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 Class ilOrgUnitPermissionQueries

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 23 of file class.ilOrgUnitPermissionQueries.php.

Member Function Documentation

assertRefIdAndPositionIdIsNotNull()

static ilOrgUnitPermissionQueries::assertRefIdAndPositionIdIsNotNull ( int  $ref_id, int  $position_id  )

staticprivate

Exceptions

ilException

Definition at line 225 of file class.ilOrgUnitPermissionQueries.php.

                                                                                            : void
    {
        if (!$ref_id) {
            throw new ilException('$ref_id cannot be null');
        }
        if (!$position_id) {
            throw new ilException('$position_id cannot be null');
        }
    }

References $ref_id.

getAllTemplateSetsForAllActivedContexts()

static ilOrgUnitPermissionQueries::getAllTemplateSetsForAllActivedContexts ( int  $position_id, bool  $editable = false  )

static

Returns

ilOrgUnitPermission[]

Exceptions

ilException

Definition at line 193 of file class.ilOrgUnitPermissionQueries.php.

                                                                                                            : array
    {
        $activated_components = [];
        foreach (ilOrgUnitGlobalSettings::getInstance()->getPositionSettings() as $ilOrgUnitObjectPositionSetting) {
            if ($ilOrgUnitObjectPositionSetting->isActive()) {
                $activated_components[] = $ilOrgUnitObjectPositionSetting->getType();
            }
        }
        $sets = [];
        foreach ($activated_components as $context) {
            $sets[] = self::getTemplateSetForContextName($context, $position_id, $editable);
        }
 
        return $sets;
    }

References $context, ilOrgUnitGlobalSettings\getInstance(), and getTemplateSetForContextName().

Referenced by ilOrgUnitDefaultPermissionGUI\index(), and ilOrgUnitDefaultPermissionGUI\update().

Here is the call graph for this function:

Here is the caller graph for this function:

getContextByRefId()

static ilOrgUnitPermissionQueries::getContextByRefId ( int  $ref_id )

staticprivate

Exceptions

ilException

Definition at line 212 of file class.ilOrgUnitPermissionQueries.php.

                                                          : ilOrgUnitOperationContext
    {
        $context = ilOrgUnitOperationContextQueries::findByRefId($ref_id);
        if (!$context) {
            throw new ilException('Context not found');
        }
 
        return $context;
    }

References $context, $ref_id, and ilOrgUnitOperationContextQueries\findByRefId().

Here is the call graph for this function:

getTemplateSetForContextName()

static ilOrgUnitPermissionQueries::getTemplateSetForContextName ( string  $context_name, string  $position_id, bool  $editable = false  )

static

Exceptions

ilException

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

                                                                                                                          : ilOrgUnitPermission
    {
        $context = ilOrgUnitOperationContextQueries::findByName($context_name);
        if (!$context) {
            throw new ilException('No context found');
        }
        if (!$position_id) {
            throw new ilException('$position_id cannot be null');
        }
 
        $template_set = ilOrgUnitPermission::where([
            'parent_id' => ilOrgUnitPermission::PARENT_TEMPLATE,
            'context_id' => $context->getId(),
            'position_id' => $position_id,
        ])->first();
 
        if (!$template_set) {
            $template_set = new ilOrgUnitPermission();
            $template_set->setParentId(ilOrgUnitPermission::PARENT_TEMPLATE);
            $template_set->setContextId($context->getId());
            $template_set->setPositionId($position_id);
            $template_set->setNewlyCreated(true);
            $template_set->create();
        }
 
        $template_set->setProtected(!$editable);
        $template_set->afterObjectLoad();
        return $template_set;
    }

References $context, ilOrgUnitOperationContextQueries\findByName(), ilOrgUnitPermission\PARENT_TEMPLATE, and ActiveRecord\where().

Referenced by ilObjEmployeeTalkAccess\canCreate(), and getAllTemplateSetsForAllActivedContexts().

Here is the call graph for this function:

Here is the caller graph for this function:

hasLocalSet()

static ilOrgUnitPermissionQueries::hasLocalSet ( int  $ref_id, int  $position_id  )

static

Definition at line 58 of file class.ilOrgUnitPermissionQueries.php.

                                                                     : bool
    {
        return (ilOrgUnitPermission::where([
            'parent_id' => $ref_id,
            'position_id' => $position_id,
        ])->hasSets());
    }

References $ref_id, and ActiveRecord\where().

Referenced by ilOrgUnitPermissionTableGUI\fillHeaderCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• Modules/OrgUnit/classes/Positions/Permissions/class.ilOrgUnitPermissionQueries.php