ilAccessInitialPermissionGuidelineAppliedObjective Class Reference

Inheritance diagram for ilAccessInitialPermissionGuidelineAppliedObjective:

Collaboration diagram for ilAccessInitialPermissionGuidelineAppliedObjective:

Public Member Functions
	__construct (string $object_type, bool $has_learning_progress=false, bool $used_for_authoring=false)
	getHash ()
	getLabel ()
	isNotable ()
	getPreconditions (Environment $environment)
	achieve (Environment $environment)
	isApplicable (Environment $environment)

Protected Attributes
const	RBAC_OP_EDIT_PERMISSIONS = 1
const	RBAC_OP_VISIBLE = 2
const	RBAC_OP_READ = 3
const	RBAC_OP_WRITE = 4
const	RBAC_OP_DELETE = 6
const	RBAC_OP_COPY = 99
array	$initial_permission_definition
array string	$object_type
bool	$has_learning_progress
bool	$used_for_authoring

Detailed Description

Definition at line 10 of file class.ilAccessInitialPermissionGuidelineAppliedObjective.php.

Constructor & Destructor Documentation

__construct()

ilAccessInitialPermissionGuidelineAppliedObjective::__construct	(	string	$object_type,
		bool	$has_learning_progress = false,
		bool	$used_for_authoring = false
	)

Definition at line 122 of file class.ilAccessInitialPermissionGuidelineAppliedObjective.php.

References $has_learning_progress, $object_type, and $used_for_authoring.

      {
        $this->object_type = $object_type;
        $this->has_learning_progress = $has_learning_progress;
        $this->used_for_authoring = $used_for_authoring;
    }

Member Function Documentation

achieve()

ilAccessInitialPermissionGuidelineAppliedObjective::achieve

(

Environment

$environment

)

Definition at line 155 of file class.ilAccessInitialPermissionGuidelineAppliedObjective.php.

References $res, ilRbacReview\_getCustomRBACOperationId(), ILIAS\Setup\Environment\getResource(), and ILIAS\Repository\int().

                                                     : Environment
    {
        $client_ini = $environment->getResource(Setup\Environment::RESOURCE_CLIENT_INI);
        $db = $environment->getResource(Environment::RESOURCE_DATABASE);

        $role_folder_id = (int) $client_ini->readVariable("system", "ROLE_FOLDER_ID");

        $learning_progress_permissions = [];
        if ($this->has_learning_progress) {
            $learning_progress_permissions = array_filter([
                ilRbacReview::_getCustomRBACOperationId("read_learning_progress"),
                ilRbacReview::_getCustomRBACOperationId("edit_learning_progress")

            ]);
        }

        foreach ($this->initial_permission_definition as $role_type => $roles) {
            foreach ($roles as $role_title => $definition) {
                if (
                    $this->used_for_authoring &&
                    array_key_exists('ignore_for_authoring_objects', $definition) &&
                    $definition['ignore_for_authoring_objects']
                ) {
                    continue;
                }

                if (array_key_exists('id', $definition) && is_numeric($definition['id'])) {
                    // According to JF (2018-07-02), some roles have to be selected by if, not by title
                    $query = "SELECT obj_id FROM object_data WHERE type = %s AND obj_id = %s";
                    $query_types = ['text', 'integer'];
                    $query_values = [$role_type, $definition['id']];
                } else {
                    $query = "SELECT obj_id FROM object_data WHERE type = %s AND title = %s";
                    $query_types = ['text', 'text'];
                    $query_values = [$role_type, $role_title];
                }

                $res = $db->queryF($query, $query_types, $query_values);
                if (1 == $db->numRows($res)) {
                    $row = $db->fetchAssoc($res);
                    $role_id = (int) $row['obj_id'];

                    $operation_ids = [];

                    if (array_key_exists('object', $definition) && is_array($definition['object'])) {
                        $operation_ids = array_merge($operation_ids, $definition['object']);
                    }

                    if (array_key_exists('lp', $definition) && $definition['lp']) {
                        $operation_ids = array_merge($operation_ids, $learning_progress_permissions);
                    }

                    foreach (array_filter(array_map('intval', $operation_ids)) as $ops_id) {
                        if ($ops_id == self::RBAC_OP_COPY) {
                            $ops_id = ilRbacReview::_getCustomRBACOperationId('copy');
                        }

                        $db->replace(
                            'rbac_templates',
                            [
                                'rol_id' => ['integer', $role_id],
                                'type' => ['text', $this->object_type],
                                'ops_id' => ['integer', $ops_id],
                                'parent' => ['integer', $role_folder_id]
                            ],
                            []
                        );
                    }

                    if (array_key_exists('create', $definition) && is_array($definition['create'])) {
                        foreach ($definition['create'] as $container_object_type) {
                            foreach (ilRbacReview::_getCustomRBACOperationId("create_" . $this->object_type) as $ops_id) {
                                if ($ops_id == self::RBAC_OP_COPY) {
                                    $ops_id = ilRbacReview::_getCustomRBACOperationId('copy');
                                }

                                $db->replace(
                                    'rbac_templates',
                                    [
                                        'rol_id' => ['integer', $role_id],
                                        'type' => ['text', $container_object_type],
                                        'ops_id' => ['integer', $ops_id],
                                        'parent' => ['integer', $role_folder_id]
                                    ],
                                    []
                                );
                            }
                        }
                    }
                }
            }
        }


        return $environment;
    }

Here is the call graph for this function:

getHash()

ilAccessInitialPermissionGuidelineAppliedObjective::getHash

(

)

Definition at line 132 of file class.ilAccessInitialPermissionGuidelineAppliedObjective.php.

                             : string
    {
        return hash("sha256", self::class);
    }

getLabel()

ilAccessInitialPermissionGuidelineAppliedObjective::getLabel

(

)

Definition at line 137 of file class.ilAccessInitialPermissionGuidelineAppliedObjective.php.

                              : string
    {
        return "Apply initial permission guideline";
    }

getPreconditions()

ilAccessInitialPermissionGuidelineAppliedObjective::getPreconditions

(

Environment

$environment

)

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

                                                              : array
    {
        return [
            new ilIniFilesLoadedObjective(),
            new ilDatabaseInitializedObjective()
        ];
    }

isApplicable()

ilAccessInitialPermissionGuidelineAppliedObjective::isApplicable

(

Environment

$environment

)

Definition at line 252 of file class.ilAccessInitialPermissionGuidelineAppliedObjective.php.

References ilRbacReview\_getCustomRBACOperationId(), and ilObject\_getObjectTypeIdByTitle().

                                                          : bool
    {
        if (!ilObject::_getObjectTypeIdByTitle($this->object_type)) {
            throw new Exception("Something went wrong, there MUST be valid id for object_type " . $this->object_type);
        }

        if (!ilRbacReview::_getCustomRBACOperationId("create_" . $this->object_type)) {
            throw new Exception(
                "Something went wrong, missing CREATE operation id for object type " . $this->object_type
            );
        }

        return true;
    }

Here is the call graph for this function:

isNotable()

ilAccessInitialPermissionGuidelineAppliedObjective::isNotable

(

)

Definition at line 142 of file class.ilAccessInitialPermissionGuidelineAppliedObjective.php.

                               : bool
    {
        return true;
    }

Field Documentation

$has_learning_progress

bool ilAccessInitialPermissionGuidelineAppliedObjective::$has_learning_progress

protected

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

Referenced by __construct().

$initial_permission_definition

array ilAccessInitialPermissionGuidelineAppliedObjective::$initial_permission_definition

protected

Initial value:

= [
        'role' => [
            'User' => [
                'id' => 4

Definition at line 19 of file class.ilAccessInitialPermissionGuidelineAppliedObjective.php.

$object_type

array string ilAccessInitialPermissionGuidelineAppliedObjective::$object_type

protected

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

Referenced by __construct().

$used_for_authoring

bool ilAccessInitialPermissionGuidelineAppliedObjective::$used_for_authoring

protected

Definition at line 120 of file class.ilAccessInitialPermissionGuidelineAppliedObjective.php.

Referenced by __construct().

RBAC_OP_COPY

const ilAccessInitialPermissionGuidelineAppliedObjective::RBAC_OP_COPY = 99

protected

Definition at line 17 of file class.ilAccessInitialPermissionGuidelineAppliedObjective.php.

RBAC_OP_DELETE

const ilAccessInitialPermissionGuidelineAppliedObjective::RBAC_OP_DELETE = 6

protected

Definition at line 16 of file class.ilAccessInitialPermissionGuidelineAppliedObjective.php.

RBAC_OP_EDIT_PERMISSIONS

const ilAccessInitialPermissionGuidelineAppliedObjective::RBAC_OP_EDIT_PERMISSIONS = 1

protected

Definition at line 12 of file class.ilAccessInitialPermissionGuidelineAppliedObjective.php.

RBAC_OP_READ

const ilAccessInitialPermissionGuidelineAppliedObjective::RBAC_OP_READ = 3

protected

Definition at line 14 of file class.ilAccessInitialPermissionGuidelineAppliedObjective.php.

RBAC_OP_VISIBLE

const ilAccessInitialPermissionGuidelineAppliedObjective::RBAC_OP_VISIBLE = 2

protected

Definition at line 13 of file class.ilAccessInitialPermissionGuidelineAppliedObjective.php.

RBAC_OP_WRITE

const ilAccessInitialPermissionGuidelineAppliedObjective::RBAC_OP_WRITE = 4

protected

Definition at line 15 of file class.ilAccessInitialPermissionGuidelineAppliedObjective.php.

---

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

• components/ILIAS/AccessControl/classes/Setup/class.ilAccessInitialPermissionGuidelineAppliedObjective.php