ilDidacticTemplateLocalPolicyAction Class Reference

Description of class. More...

Inheritance diagram for ilDidacticTemplateLocalPolicyAction:

Collaboration diagram for ilDidacticTemplateLocalPolicyAction:

Public Member Functions
	__construct (int $action_id=0)
	addFilterPattern (ilDidacticTemplateFilterPattern $pattern)
	setFilterPatterns (array $patterns)
	Set filter patterns. More...
	getFilterPattern ()
	Get filter pattern. More...
	setFilterType (int $a_type)
	getFilterType ()
	setRoleTemplateType (int $a_tpl_type)
	getRoleTemplateType ()
	setRoleTemplateId (int $a_id)
	getRoleTemplateId ()
	save ()
	delete ()
	apply ()
	revert ()
	getType ()
	toXml (ilXmlWriter $writer)
	__clone ()
	read ()
Public Member Functions inherited from ilDidacticTemplateAction
	__construct (int $action_id=0)
	getLogger ()
	getActionId ()
	setActionId (int $a_action_id)
	setType (int $a_type_id)
	setTemplateId (int $a_id)
	getTemplateId ()
	setRefId (int $a_ref_id)
	getRefId ()
	save ()
	Write action to db Overwrite for filling additional db fields. More...
	delete ()
	Delete didactic template action Overwrite for filling additional db fields. More...
	read ()
	getType ()
	Get type of template. More...
	apply ()
	Apply action. More...
	revert ()
	Implement everthing that is necessary to revert a didactic template return bool. More...
	__clone ()
	toXml (ilXmlWriter $writer)

Data Fields
const	TPL_ACTION_OVERWRITE = 1
const	TPL_ACTION_INTERSECT = 2
const	TPL_ACTION_ADD = 3
const	TPL_ACTION_SUBTRACT = 4
const	TPL_ACTION_UNION = 5
Data Fields inherited from ilDidacticTemplateAction
const	TYPE_LOCAL_POLICY = 1
const	TYPE_LOCAL_ROLE = 2
const	TYPE_BLOCK_ROLE = 3
const	FILTER_SOURCE_TITLE = 1
const	FILTER_SOURCE_OBJ_ID = 2
const	FILTER_PARENT_ROLES = 3
const	FILTER_LOCAL_ROLES = 4
const	PATTERN_PARENT_TYPE = 'action'

Protected Member Functions
	createLocalPolicy (ilObject $source, array $role)
	revertLocalPolicy (ilObject $source, array $role)
Protected Member Functions inherited from ilDidacticTemplateAction
	initSourceObject ()
	filterRoles (ilObject $source)

Private Attributes
array	$pattern = []
int	$filter_type = self::FILTER_SOURCE_TITLE
int	$role_template_type = self::TPL_ACTION_OVERWRITE
int	$role_template_id = 0

Additional Inherited Members
Protected Attributes inherited from ilDidacticTemplateAction
ilLogger	$logger
ilDBInterface	$db
ilRbacReview	$review
ilRbacAdmin	$admin

Detailed Description

Description of class.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 11 of file class.ilDidacticTemplateLocalPolicyAction.php.

Constructor & Destructor Documentation

__construct()

ilDidacticTemplateLocalPolicyAction::__construct

(

int

$action_id = 0

)

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

References ilDidacticTemplateAction\$action_id, and ILIAS\GlobalScreen\Provider\__construct().

    {
        parent::__construct($action_id);
    }

Here is the call graph for this function:

Member Function Documentation

__clone()

ilDidacticTemplateLocalPolicyAction::__clone

(

)

Definition at line 260 of file class.ilDidacticTemplateLocalPolicyAction.php.

References $pattern, getFilterPattern(), and setFilterPatterns().

    {
        parent::__clone();

        $clones = [];
        foreach ($this->getFilterPattern() as $pattern) {
            $clones[] = clone $pattern;
        }
        $this->setFilterPatterns($clones);
    }

Here is the call graph for this function:

addFilterPattern()

ilDidacticTemplateLocalPolicyAction::addFilterPattern

(

ilDidacticTemplateFilterPattern

$pattern

)

Definition at line 30 of file class.ilDidacticTemplateLocalPolicyAction.php.

References $pattern.

Referenced by read().

                                                                              : void
    {
        $this->pattern[] = $pattern;
    }

Here is the caller graph for this function:

apply()

ilDidacticTemplateLocalPolicyAction::apply

(

)

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

References $source, createLocalPolicy(), ilDidacticTemplateAction\filterRoles(), ilDidacticTemplateAction\getLogger(), and ilDidacticTemplateAction\initSourceObject().

                           : bool
    {
        $source = $this->initSourceObject();
        // Create a role folder for the new local policies
        $roles = $this->filterRoles($source);

        // Create local policy for filtered roles
        foreach ($roles as $role_id => $role) {
            $this->getLogger()->debug('Apply to role: ' . $role['title']);
            $this->getLogger()->debug('Role parent: ' . $role['parent']);
            $this->getLogger()->debug('Source ref_id: ' . $source->getRefId());

            // No local policies for protected roles of higher context
            if (
                (int) $role['parent'] !== $source->getRefId() &&
                $this->review->isProtected($role['parent'], $role_id)
            ) {
                $this->getLogger()->debug('Ignoring protected role.');
                continue;
            }
            $this->createLocalPolicy($source, $role);
        }

        return true;
    }

Here is the call graph for this function:

createLocalPolicy()

ilDidacticTemplateLocalPolicyAction::createLocalPolicy ( ilObject  $source, array  $role  )

protected

Definition at line 291 of file class.ilDidacticTemplateLocalPolicyAction.php.

References ilDidacticTemplateAction\getLogger(), ilObject\getRefId(), getRoleTemplateId(), getRoleTemplateType(), ILIAS\Repository\int(), ILIAS\Repository\logger(), ilObjRole\MODE_PROTECTED_DELETE_LOCAL_POLICIES, ilObjRole\MODE_UNPROTECTED_DELETE_LOCAL_POLICIES, and ROLE_FOLDER_ID.

Referenced by apply().

                                                                       : bool
    {
        // fetch role information
        $role_data = [];
        foreach ($this->review->getParentRoleIds($source->getRefId()) as $role_id => $tmp_role) {
            if ((int) $role_id === (int) $role['obj_id']) {
                $role_data = $tmp_role;
            }
        }

        // Add local policy
        if (!$this->review->isRoleAssignedToObject((int) $role['obj_id'], $source->getRefId())) {
            $this->admin->assignRoleToFolder(
                (int) $role['obj_id'],
                $source->getRefId(),
                'n'
            );
        }

        // do nothing if role is protected in higher context
        if (
            (int) $role['parent'] !== $source->getRefId() &&
            $this->review->isProtected($source->getRefId(), (int) $role['obj_id'])
        ) {
            $this->getLogger()->info('Ignoring protected role: ' . $role['title']);
            return false;
        }

        switch ($this->getRoleTemplateType()) {
            case self::TPL_ACTION_UNION:

                $this->logger->info('Using ilRbacAdmin::copyRolePermissionUnion()');
                $this->admin->copyRolePermissionUnion(
                    (int) $role_data['obj_id'],
                    (int) $role_data['parent'],
                    $this->getRoleTemplateId(),
                    ROLE_FOLDER_ID,
                    (int) $role_data['obj_id'],
                    $source->getRefId()
                );
                break;

            case self::TPL_ACTION_OVERWRITE:

                $this->logger->info('Using ilRbacAdmin::copyRoleTemplatePermission()');
                $this->admin->copyRoleTemplatePermissions(
                    $this->getRoleTemplateId(),
                    ROLE_FOLDER_ID,
                    $source->getRefId(),
                    (int) $role_data['obj_id'],
                    true
                );
                break;

            case self::TPL_ACTION_INTERSECT:

                $this->logger->info('Using ilRbacAdmin::copyRolePermissionIntersection()' . $this->getRoleTemplateId());
                $this->admin->copyRolePermissionIntersection(
                    (int) $role_data['obj_id'],
                    (int) $role_data['parent'],
                    $this->getRoleTemplateId(),
                    ROLE_FOLDER_ID,
                    $source->getRefId(),
                    (int) $role_data['obj_id']
                );
                break;

        }
        // Change existing object
        $role_obj = new ilObjRole((int) $role_data['obj_id']);
        $role_obj->changeExistingObjects(
            $source->getRefId(),
            $role_data['protected'] ? ilObjRole::MODE_PROTECTED_DELETE_LOCAL_POLICIES : ilObjRole::MODE_UNPROTECTED_DELETE_LOCAL_POLICIES,
            ['all']
        );

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilDidacticTemplateLocalPolicyAction::delete

(

)

Definition at line 108 of file class.ilDidacticTemplateLocalPolicyAction.php.

References $query, ilDidacticTemplateAction\getActionId(), and getFilterPattern().

                            : void
    {
        parent::delete();
        $query = 'DELETE FROM didactic_tpl_alp ' .
            'WHERE action_id  = ' . $this->db->quote($this->getActionId(), 'integer');
        $this->db->manipulate($query);

        foreach ($this->getFilterPattern() as $pattern) {
            $pattern->delete();
        }
    }

Here is the call graph for this function:

getFilterPattern()

ilDidacticTemplateLocalPolicyAction::getFilterPattern

(

)

Get filter pattern.

Returns

ilDidacticTemplateFilterPattern[]

Definition at line 48 of file class.ilDidacticTemplateLocalPolicyAction.php.

References $pattern.

Referenced by __clone(), delete(), save(), and toXml().

                                      : array
    {
        return $this->pattern;
    }

Here is the caller graph for this function:

getFilterType()

ilDidacticTemplateLocalPolicyAction::getFilterType

(

)

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

References $filter_type.

Referenced by save(), and toXml().

                                   : int
    {
        return $this->filter_type;
    }

Here is the caller graph for this function:

getRoleTemplateId()

ilDidacticTemplateLocalPolicyAction::getRoleTemplateId

(

)

Definition at line 78 of file class.ilDidacticTemplateLocalPolicyAction.php.

References $role_template_id.

Referenced by createLocalPolicy(), save(), and toXml().

                                       : int
    {
        return $this->role_template_id;
    }

Here is the caller graph for this function:

getRoleTemplateType()

ilDidacticTemplateLocalPolicyAction::getRoleTemplateType

(

)

Definition at line 68 of file class.ilDidacticTemplateLocalPolicyAction.php.

References $role_template_type.

Referenced by createLocalPolicy(), save(), and toXml().

                                         : int
    {
        return $this->role_template_type;
    }

Here is the caller graph for this function:

getType()

ilDidacticTemplateLocalPolicyAction::getType

(

)

Definition at line 183 of file class.ilDidacticTemplateLocalPolicyAction.php.

                             : int
    {
        return self::TYPE_LOCAL_POLICY;
    }

read()

ilDidacticTemplateLocalPolicyAction::read

(

)

Definition at line 271 of file class.ilDidacticTemplateLocalPolicyAction.php.

References $query, $res, addFilterPattern(), ilDBConstants\FETCHMODE_OBJECT, ilDidacticTemplateAction\getActionId(), ilDidacticTemplateFilterPatternFactory\lookupPatternsByParentId(), setFilterType(), setRoleTemplateId(), setRoleTemplateType(), and ilDBConstants\T_INTEGER.

                          : void
    {
        parent::read();
        $query = 'SELECT * FROM didactic_tpl_alp ' .
            'WHERE action_id = ' . $this->db->quote($this->getActionId(), ilDBConstants::T_INTEGER);
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->setFilterType((int) $row->filter_type);
            $this->setRoleTemplateType((int) $row->template_type);
            $this->setRoleTemplateId((int) $row->template_id);
        }
        // Read filter
        foreach (ilDidacticTemplateFilterPatternFactory::lookupPatternsByParentId(
            $this->getActionId(),
            self::PATTERN_PARENT_TYPE
        ) as $pattern) {
            $this->addFilterPattern($pattern);
        }
    }

Here is the call graph for this function:

revert()

ilDidacticTemplateLocalPolicyAction::revert

(

)

Definition at line 146 of file class.ilDidacticTemplateLocalPolicyAction.php.

References $source, ilDidacticTemplateAction\filterRoles(), ilDidacticTemplateAction\getLogger(), ilDidacticTemplateAction\initSourceObject(), ilObjRole\MODE_PROTECTED_DELETE_LOCAL_POLICIES, ilObjRole\MODE_UNPROTECTED_DELETE_LOCAL_POLICIES, and revertLocalPolicy().

                            : bool
    {
        $source = $this->initSourceObject();
        $roles = $this->filterRoles($source);

        // Delete local policy for filtered roles
        foreach ($roles as $role_id => $role) {
            // Do not delete local policies of auto generated roles
            if (!$this->review->isGlobalRole($role['obj_id']) &&
                $this->review->isAssignable($role['obj_id'], $source->getRefId()) &&
                $this->review->isSystemGeneratedRole($role['obj_id'])) {
                $this->getLogger()->debug('Reverting local policy of auto generated role: ' . $role['title']);
                $this->revertLocalPolicy($source, $role);
            } else {
                $this->getLogger()->debug('Reverting local policy and deleting local role: ' . $role['title']);

                // delete local role and change exiting objects
                $this->admin->deleteLocalRole($role_id, $source->getRefId());

                // Change existing object
                $role_obj = new ilObjRole($role_id);

                $protected = $this->review->isProtected($role['parent'], $role['rol_id']);

                $role_obj->changeExistingObjects(
                    $source->getRefId(),
                    $protected ?
                        ilObjRole::MODE_PROTECTED_DELETE_LOCAL_POLICIES :
                        ilObjRole::MODE_UNPROTECTED_DELETE_LOCAL_POLICIES,
                    ['all']
                );
            }
        }

        return true;
    }

Here is the call graph for this function:

revertLocalPolicy()

ilDidacticTemplateLocalPolicyAction::revertLocalPolicy ( ilObject  $source, array  $role  )

protected

Definition at line 370 of file class.ilDidacticTemplateLocalPolicyAction.php.

References $query, $res, ilDBConstants\FETCHMODE_OBJECT, ilObject\getRefId(), ILIAS\Repository\int(), ILIAS\Repository\logger(), ilObjRole\MODE_PROTECTED_DELETE_LOCAL_POLICIES, ilObjRole\MODE_UNPROTECTED_DELETE_LOCAL_POLICIES, and ROLE_FOLDER_ID.

Referenced by revert().

                                                                       : bool
    {
        $this->logger->info('Reverting policy for role ' . $role['title']);
        // Local policies can only be reverted for auto generated roles. Otherwise the
        // original role settings are unknown
        if (strpos($role['title'], 'il_') !== 0) {
            $this->logger->warning('Cannot revert local policy for role ' . $role['title']);
            return false;
        }

        // No local policies
        if (!$this->review->getLocalPolicies($source->getRefId())) {
            return false;
        }

        $exploded_title = explode('_', $role['title']);
        $rolt_title = $exploded_title[0] . '_' . $exploded_title[1] . '_' . $exploded_title[2];

        // Lookup role template
        $query = 'SELECT obj_id FROM object_data ' .
            'WHERE title = ' . $this->db->quote($rolt_title, 'text') . ' ' .
            'AND type = ' . $this->db->quote('rolt', 'text');
        $res = $this->db->query($query);
        $rolt_id = 0;
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $rolt_id = (int) $row->obj_id;
        }

        // No template found
        if (!$rolt_id) {
            return false;
        }

        $this->admin->copyRoleTemplatePermissions(
            $rolt_id,
            ROLE_FOLDER_ID,
            $source->getRefId(),
            (int) $role['obj_id'],
            true
        );

        // Change existing object
        $role_obj = new ilObjRole((int) $role['obj_id']);
        $role_obj->changeExistingObjects(
            $source->getRefId(),
            $role['protected'] ? ilObjRole::MODE_PROTECTED_DELETE_LOCAL_POLICIES : ilObjRole::MODE_UNPROTECTED_DELETE_LOCAL_POLICIES,
            ['all']
        );

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilDidacticTemplateLocalPolicyAction::save

(

)

Definition at line 83 of file class.ilDidacticTemplateLocalPolicyAction.php.

References $query, ilDidacticTemplateAction\getActionId(), getFilterPattern(), getFilterType(), getRoleTemplateId(), and getRoleTemplateType().

                          : int
    {
        if (!parent::save()) {
            return 0;
        }

        $query = 'INSERT INTO didactic_tpl_alp (action_id,filter_type,template_type,template_id) ' .
            'VALUES( ' .
            $this->db->quote($this->getActionId(), 'integer') . ', ' .
            $this->db->quote($this->getFilterType(), 'integer') . ', ' .
            $this->db->quote($this->getRoleTemplateType(), 'integer') . ', ' .
            $this->db->quote($this->getRoleTemplateId(), 'integer') . ' ' .
            ')';
        $this->db->manipulate($query);

        foreach ($this->getFilterPattern() as $pattern) {
            /* @var ilDidacticTemplateFilterPattern $pattern */
            $pattern->setParentId($this->getActionId());
            $pattern->setParentType(self::PATTERN_PARENT_TYPE);
            $pattern->save();
        }

        return $this->getActionId();
    }

Here is the call graph for this function:

setFilterPatterns()

ilDidacticTemplateLocalPolicyAction::setFilterPatterns

(

array

$patterns

)

Set filter patterns.

Parameters

ilDidacticTemplateExcludeFilterPattern[]

$patterns

Definition at line 39 of file class.ilDidacticTemplateLocalPolicyAction.php.

Referenced by __clone().

                                                      : void
    {
        $this->pattern = $patterns;
    }

Here is the caller graph for this function:

setFilterType()

ilDidacticTemplateLocalPolicyAction::setFilterType

(

int

$a_type

)

Definition at line 53 of file class.ilDidacticTemplateLocalPolicyAction.php.

Referenced by read().

                                              : void
    {
        $this->filter_type = $a_type;
    }

Here is the caller graph for this function:

setRoleTemplateId()

ilDidacticTemplateLocalPolicyAction::setRoleTemplateId

(

int

$a_id

)

Definition at line 73 of file class.ilDidacticTemplateLocalPolicyAction.php.

Referenced by read().

                                                : void
    {
        $this->role_template_id = $a_id;
    }

Here is the caller graph for this function:

setRoleTemplateType()

ilDidacticTemplateLocalPolicyAction::setRoleTemplateType

(

int

$a_tpl_type

)

Definition at line 63 of file class.ilDidacticTemplateLocalPolicyAction.php.

Referenced by read().

                                                        : void
    {
        $this->role_template_type = $a_tpl_type;
    }

Here is the caller graph for this function:

toXml()

ilDidacticTemplateLocalPolicyAction::toXml

(

ilXmlWriter

$writer

)

Definition at line 188 of file class.ilDidacticTemplateLocalPolicyAction.php.

References ilObject\_lookupType(), ilXmlWriter\appendXML(), getFilterPattern(), getFilterType(), getRoleTemplateId(), getRoleTemplateType(), IL_INST_ID, ilRoleXmlExport\MODE_DTPL, ROLE_FOLDER_ID, ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

                                              : void
    {
        $writer->xmlStartTag('localPolicyAction');

        switch ($this->getFilterType()) {

            case self::FILTER_SOURCE_OBJ_ID:
                $writer->xmlStartTag('roleFilter', ['source' => 'objId']);
                break;

            case self::FILTER_PARENT_ROLES:
                $writer->xmlStartTag('roleFilter', ['source' => 'parentRoles']);
                break;

            case self::FILTER_LOCAL_ROLES:
                $writer->xmlStartTag('roleFilter', ['source' => 'localRoles']);
                break;

            case self::FILTER_SOURCE_TITLE:
            default:
                $writer->xmlStartTag('roleFilter', ['source' => 'title']);
                break;
        }

        foreach ($this->getFilterPattern() as $pattern) {
            $pattern->toXml($writer);
        }
        $writer->xmlEndTag('roleFilter');

        $il_role_id = 'il_' . IL_INST_ID . '_' . ilObject::_lookupType($this->getRoleTemplateId()) . '_' . $this->getRoleTemplateId();

        switch ($this->getRoleTemplateType()) {
            case self::TPL_ACTION_OVERWRITE:
                $writer->xmlStartTag(
                    'localPolicyTemplate',
                    [
                        'type' => 'overwrite',
                        'id' => $il_role_id
                    ]
                );
                break;

            case self::TPL_ACTION_INTERSECT:
                $writer->xmlStartTag(
                    'localPolicyTemplate',
                    [
                        'type' => 'intersect',
                        'id' => $il_role_id
                    ]
                );
                break;

            case self::TPL_ACTION_UNION:
                $writer->xmlStartTag(
                    'localPolicyTemplate',
                    [
                        'type' => 'union',
                        'id' => $il_role_id
                    ]
                );
                break;
        }

        $exp = new ilRoleXmlExport();
        $exp->setMode(ilRoleXmlExport::MODE_DTPL);
        $exp->addRole($this->getRoleTemplateId(), ROLE_FOLDER_ID);
        $exp->write();
        $writer->appendXML($exp->xmlDumpMem(false));
        $writer->xmlEndTag('localPolicyTemplate');
        $writer->xmlEndTag('localPolicyAction');
    }

Here is the call graph for this function:

Field Documentation

$filter_type

int ilDidacticTemplateLocalPolicyAction::$filter_type = self::FILTER_SOURCE_TITLE

private

Definition at line 21 of file class.ilDidacticTemplateLocalPolicyAction.php.

Referenced by getFilterType().

$pattern

array ilDidacticTemplateLocalPolicyAction::$pattern = []

private

Definition at line 20 of file class.ilDidacticTemplateLocalPolicyAction.php.

Referenced by __clone(), addFilterPattern(), and getFilterPattern().

$role_template_id

int ilDidacticTemplateLocalPolicyAction::$role_template_id = 0

private

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

Referenced by getRoleTemplateId().

$role_template_type

int ilDidacticTemplateLocalPolicyAction::$role_template_type = self::TPL_ACTION_OVERWRITE

private

Definition at line 22 of file class.ilDidacticTemplateLocalPolicyAction.php.

Referenced by getRoleTemplateType().

TPL_ACTION_ADD

const ilDidacticTemplateLocalPolicyAction::TPL_ACTION_ADD = 3

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

TPL_ACTION_INTERSECT

const ilDidacticTemplateLocalPolicyAction::TPL_ACTION_INTERSECT = 2

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

Referenced by ilDidacticTemplateImport\parseActions().

TPL_ACTION_OVERWRITE

const ilDidacticTemplateLocalPolicyAction::TPL_ACTION_OVERWRITE = 1

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

Referenced by ilDidacticTemplateImport\parseActions().

TPL_ACTION_SUBTRACT

const ilDidacticTemplateLocalPolicyAction::TPL_ACTION_SUBTRACT = 4

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

TPL_ACTION_UNION

const ilDidacticTemplateLocalPolicyAction::TPL_ACTION_UNION = 5

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

Referenced by ilDidacticTemplateImport\parseActions().

---

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

• Services/DidacticTemplate/classes/Action/class.ilDidacticTemplateLocalPolicyAction.php