ILIAS\Administration\Setup\Objective\DropPermissions Class Reference

Inheritance diagram for ILIAS\Administration\Setup\Objective\DropPermissions:

Collaboration diagram for ILIAS\Administration\Setup\Objective\DropPermissions:

Public Member Functions
	__construct (private string $type, private array $operations, private array $additional_preconditions=[])
	getHash ()
	Get a hash for this objective. More...
	getLabel ()
	Get a label that describes this objective. More...
	isNotable ()
	Get to know if this is an interesting objective for a human. More...
	getPreconditions (Environment $environment)
	Objectives might depend on other objectives. More...
	achieve (Environment $environment)
	Objectives can be achieved. More...
	isApplicable (Environment $environment)
	Get to know whether the objective is applicable. More...
	getHash ()
	Get a hash for this objective. More...
	getLabel ()
	Get a label that describes this objective. More...
	isNotable ()
	Get to know if this is an interesting objective for a human. More...
	getPreconditions (Environment $environment)
	Objectives might depend on other objectives. More...
	achieve (Environment $environment)
	Objectives can be achieved. More...
	isApplicable (Environment $environment)
	Get to know whether the objective is applicable. More...

Private Member Functions
	operations (Environment $environment)
	firstRefIdOfType (ilDBInterface $db, string $type)

Detailed Description

Definition at line 32 of file DropPermissions.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Administration\Setup\Objective\DropPermissions::__construct	(	private string	$type,
		private array	$operations,
		private array	$additional_preconditions = []
	)

Parameters

int[]	$operations
Objective[]	$additional_preconditions

Definition at line 38 of file DropPermissions.php.

      {
    }

Member Function Documentation

achieve()

ILIAS\Administration\Setup\Objective\DropPermissions::achieve

(

Environment

$environment

)

Objectives can be achieved.

They might add resources to the environment when they have been achieved.

This method needs to be idempotent for a given environment. That means: if this is executed a second time, nothing new should happen. Or the other way round: if the environment already looks like desired, the objective should not take any further actions when this is called.

Exceptions

LogicException if there are unfullfilled preconditions.

Exceptions

RuntimeException if there are missing resources.

Implements ILIAS\Setup\Objective.

Definition at line 68 of file DropPermissions.php.

                                                     : Environment
    {
        $db = $environment->getResource(Environment::RESOURCE_DATABASE);
        $operations = $this->operations($environment);
        $ref_id = $this->firstRefIdOfType($db, $this->type);
        if (!$ref_id) {
            return $environment;
        }
 
        foreach ($operations as $operation) {
            $objective = new ilAccessRBACOperationDeletedObjective($this->type, $operation);
            $objective->achieve($environment);
        }
 
        // rbac_pa is not cleanup by ilAccessRBACOperationDeletedObjective::class.
        $update_row = $db->prepare('UPDATE rbac_pa SET ops_id = ? WHERE rol_id = ? AND ref_id = ?', [ilDBConstants::T_TEXT, ilDBConstants::T_INTEGER]);
        $delete_row = $db->prepare('DELETE FROM rbac_pa WHERE rol_id = ? AND ref_id = ?', [ilDBConstants::T_INTEGER, ilDBConstants::T_INTEGER]);
        foreach ($db->fetchAll($db->queryF('SELECT * FROM rbac_pa WHERE ref_id = %s', [ilDBConstants::T_INTEGER], [$ref_id])) as $row) {
            $ops_id = unserialize($row['ops_id'], ['allowed_classes' => false]);
            $ops_id = array_values(array_filter($ops_id, fn($op) => !in_array($op, $operations, false)));
            if ($ops_id === []) {
                $db->execute($delete_row, [$row['rol_id'], $ref_id]);
            } else {
                $db->execute($update_row, [serialize($ops_id), $row['rol_id'], $ref_id]);
            }
        }
 
        return $environment;
    }

References ILIAS\$db, $ref_id, ILIAS\Administration\Setup\Objective\DropPermissions\firstRefIdOfType(), ILIAS\Setup\Environment\getResource(), ILIAS\Administration\Setup\Objective\DropPermissions\operations(), ILIAS\Setup\Environment\RESOURCE_DATABASE, ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

Here is the call graph for this function:

firstRefIdOfType()

ILIAS\Administration\Setup\Objective\DropPermissions::firstRefIdOfType ( ilDBInterface  $db, string  $type  )

private

Definition at line 121 of file DropPermissions.php.

                                                                      : int
    {
        $ref_query = 'SELECT ref_id FROM object_reference AS r INNER JOIN object_data AS o ON r.obj_id = o.obj_id where type = %s';
        return (int) ($db->fetchAssoc($db->queryF($ref_query, [ilDBConstants::T_TEXT], [$type]))['ref_id'] ?? 0);
    }

References ILIAS\$db, and ilDBConstants\T_TEXT.

Referenced by ILIAS\Administration\Setup\Objective\DropPermissions\achieve().

Here is the caller graph for this function:

getHash()

ILIAS\Administration\Setup\Objective\DropPermissions::getHash

(

)

Get a hash for this objective.

The hash of two objectives must be the same, if they are the same objective, with the same config on the same environment, i.e. if the one is achieved the other is achieved as well because they are the same.

Implements ILIAS\Setup\Objective.

Definition at line 45 of file DropPermissions.php.

                             : string
    {
        return hash("sha256", self::class . $this->type . ',' . join(',', $this->operations));
    }

References ILIAS\Administration\Setup\Objective\DropPermissions\operations().

Here is the call graph for this function:

getLabel()

ILIAS\Administration\Setup\Objective\DropPermissions::getLabel

(

)

Get a label that describes this objective.

Implements ILIAS\Setup\Objective.

Definition at line 50 of file DropPermissions.php.

                              : string
    {
        return 'Drop permissions ' . join(', ', $this->operations) . ' from ' . $this->type;
    }

References ILIAS\Administration\Setup\Objective\DropPermissions\operations().

Here is the call graph for this function:

getPreconditions()

ILIAS\Administration\Setup\Objective\DropPermissions::getPreconditions

(

Environment

$environment

)

Objectives might depend on other objectives.

Exceptions

UnachievableException

if the objective is not achievable

Returns

Objective[]

Implements ILIAS\Setup\Objective.

Definition at line 60 of file DropPermissions.php.

                                                              : array
    {
        return [
            new ilDatabaseInitializedObjective(),
            ...$this->additional_preconditions,
        ];
    }

isApplicable()

ILIAS\Administration\Setup\Objective\DropPermissions::isApplicable

(

Environment

$environment

)

Get to know whether the objective is applicable.

Don't change the environment or cause changes on services in the environment. Just check if this objective needs to be achieved, either currently or at all. In case of doubt whether the objective is applicable or not return true.

Implements ILIAS\Setup\Objective.

Definition at line 98 of file DropPermissions.php.

                                                          : bool
    {
        return $this->operations($environment) !== [];
    }

References ILIAS\Administration\Setup\Objective\DropPermissions\operations().

Here is the call graph for this function:

isNotable()

ILIAS\Administration\Setup\Objective\DropPermissions::isNotable

(

)

Get to know if this is an interesting objective for a human.

Implements ILIAS\Setup\Objective.

Definition at line 55 of file DropPermissions.php.

                               : bool
    {
        return true;
    }

operations()

ILIAS\Administration\Setup\Objective\DropPermissions::operations ( Environment  $environment )

private

Returns

int[]

Definition at line 106 of file DropPermissions.php.

                                                         : array
    {
        $db = $environment->getResource(Environment::RESOURCE_DATABASE);
 
        $s = $db->query(
            'SELECT ops_id FROM rbac_ta WHERE ' .
            $db->in('ops_id', $this->operations, false, ilDBConstants::T_INTEGER) .
            ' AND typ_id IN (SELECT obj_id FROM object_data WHERE title = ' .
            $db->quote($this->type, ilDBConstants::T_TEXT) .
            ' AND type = "typ")'
        );
 
        return array_map('intval', array_column($db->fetchAll($s), 'ops_id'));
    }

References ILIAS\$db, ILIAS\Setup\Environment\getResource(), ILIAS\Setup\Environment\RESOURCE_DATABASE, ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

Referenced by ILIAS\Administration\Setup\Objective\DropPermissions\achieve(), ILIAS\Administration\Setup\Objective\DropPermissions\getHash(), ILIAS\Administration\Setup\Objective\DropPermissions\getLabel(), and ILIAS\Administration\Setup\Objective\DropPermissions\isApplicable().

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:

• components/ILIAS/Administration/classes/Setup/Objective/DropPermissions.php