Description of class. More...

Inheritance diagram for ilDidacticTemplateLocalPolicyAction:

Collaboration diagram for ilDidacticTemplateLocalPolicyAction:

Public Member Functions
	__construct ($action_id=0)
	Constructor. More...

	addFilterPattern (ilDidacticTemplateFilterPattern $pattern)
	Add filter. More...

	setFilterPatterns (array $patterns)
	Set filter patterns. More...

	getFilterPattern ()
	Get filter pattern. More...

	setFilterType ($a_type)
	Set filter type. More...

	getFilterType ()
	Get filter type. More...

	setRoleTemplateType ($a_tpl_type)
	Set Role template type. More...

	getRoleTemplateType ()
	Get role template type. More...

	setRoleTemplateId ($a_id)
	Set role template id. More...

	getRoleTemplateId ()
	Get role template id. More...

	save ()
	Save action. More...

	delete ()
	delete action filter ilDB $ilDB More...

	apply ()
	Apply action. More...

	revert ()
	Revert action. More...

	getType ()
	Get action type. More...

	toXml (ilXmlWriter $writer)
	Export to xml. More...

	__clone ()
	clone method More...

	read ()

Public Member Functions inherited from ilDidacticTemplateAction
	__construct ($action_id=0)
	Constructor. More...

	getLogger ()
	Get logger. More...

	getActionId ()
	Get action id. More...

	setActionId ($a_action_id)
	Set action id. More...

	setType ($a_type_id)
	Set type id. More...

	setTemplateId ($a_id)
	Set template id. More...

	getTemplateId ()
	Get template id. More...

	setRefId ($a_ref_id)
	Set ref id of target object. More...

	getRefId ()
	Get ref id of target object. More...

	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 ()
	ilDB $ilDB More...

	getType ()
	Get type of template. More...

	apply ()
	Apply action. More...

	revert ()
	Implement everthing that is necessary to revert a didactic template. More...

	__clone ()
	Clone method. More...

	toXml (ilXmlWriter $writer)
	Write xml for export. More...

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, $role)
	Create local policy. More...

	revertLocalPolicy (ilObject $source, $role)

Protected Member Functions inherited from ilDidacticTemplateAction
	initSourceObject ()
	Init the source object. More...

	filterRoles (ilObject $source)
	Filter roles. More...

Private Attributes
	$pattern = array()

	$filter_type = self::FILTER_SOURCE_TITLE

	$role_template_type = self::TPL_ACTION_OVERWRITE

	$role_template_id = 0

Detailed Description

Description of class.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilDidacticTemplateLocalPolicyAction::__construct ( $action_id = 0 )

Constructor.

Parameters

int $action_id

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

References ilDidacticTemplateAction\$action_id.

     {
         parent::__construct($action_id);
     }

Member Function Documentation

◆ __clone()

ilDidacticTemplateLocalPolicyAction::__clone ( )

clone method

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

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

     {
         parent::__clone();
 
         // Clone patterns
         $cloned = array();
         foreach ($this->getFilterPattern() as $pattern) {
             $clones[] = clone $pattern;
         }
         $this->setFilterPatterns($clones);
     }

Here is the call graph for this function:

◆ addFilterPattern()

ilDidacticTemplateLocalPolicyAction::addFilterPattern ( ilDidacticTemplateFilterPattern $pattern )

Add filter.

Parameters

ilDidacticTemplateFilterPatter $pattern

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

References $pattern.

Referenced by read().

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

Here is the caller graph for this function:

◆ apply()

ilDidacticTemplateLocalPolicyAction::apply ( )

Apply action.

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

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

     {
         $rbacreview = $GLOBALS['DIC']->rbac()->review();
 
         $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 (
                 $rbacreview->isProtected($role['parent'], $role_id) &&
                 $role['parent'] != $source->getRefId()
             ) {
                 $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,
			$role
	)

protected

Create local policy.

Parameters

ilObject	$source
array	$role

Returns: bool

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

References $DIC, $GLOBALS, ilDidacticTemplateAction\getLogger(), ilLoggerFactory\getLogger(), ilObject\getRefId(), getRoleTemplateId(), getRoleTemplateType(), ilObjRole\MODE_PROTECTED_DELETE_LOCAL_POLICIES, and ilObjRole\MODE_UNPROTECTED_DELETE_LOCAL_POLICIES.

Referenced by apply().

     {
         global $DIC;
 
         $rbacreview = $DIC->rbac()->review();
         $rbacadmin = $DIC->rbac()->admin();
         
         // fetch role information
         $role_data = array();
         foreach ($rbacreview->getParentRoleIds($source->getRefId()) as $role_id => $tmp_role) {
             if ($role_id == $role['obj_id']) {
                 $role_data = $tmp_role;
             }
         }
         
         // Add local policy
         if (!$rbacreview->isRoleAssignedToObject($role['obj_id'], $source->getRefId())) {
             $GLOBALS['DIC']->rbac()->admin()->assignRoleToFolder(
                 $role['obj_id'],
                 $source->getRefId(),
                 'n'
             );
         }
 
 
         // do nothing if role is protected in higher context
         if (
             $rbacreview->isProtected($source->getRefId(),$role['obj_id']) &&
             $role['parent'] != $source->getRefId()
         ) {
             $this->getLogger()->info('Ignoring protected role: ' . $role['title']);
             return true;
         }
 
         switch ($this->getRoleTemplateType()) {
             case self::TPL_ACTION_UNION:
 
                 ilLoggerFactory::getLogger('otpl')->info('Using ilRbacAdmin::copyRolePermissionUnion()');
                 $rbacadmin->copyRolePermissionUnion(
                     $role_data['obj_id'],
                     $role_data['parent'],
                     $this->getRoleTemplateId(),
                     ROLE_FOLDER_ID,
                     $role_data['obj_id'],
                     $source->getRefId()
                 );
                 break;
 
             case self::TPL_ACTION_OVERWRITE:
 
                 ilLoggerFactory::getLogger('otpl')->info('Using ilRbacAdmin::copyRoleTemplatePermission()');
                 $rbacadmin->copyRoleTemplatePermissions(
                     $this->getRoleTemplateId(),
                     ROLE_FOLDER_ID,
                     $source->getRefId(),
                     $role_data['obj_id'],
                     true
                 );
                 break;
 
             case self::TPL_ACTION_INTERSECT:
 
                 ilLoggerFactory::getLogger('otpl')->info('Using ilRbacAdmin::copyRolePermissionIntersection()' . $this->getRoleTemplateId());
                 $rbacadmin->copyRolePermissionIntersection(
                     $role_data['obj_id'],
                     $role_data['parent'],
                     $this->getRoleTemplateId(),
                     ROLE_FOLDER_ID,
                     $source->getRefId(),
                     $role_data['obj_id']
                 );
                 break;
 
         }
 
         // Change existing object
         include_once './Services/AccessControl/classes/class.ilObjRole.php';
         $role_obj = new ilObjRole($role_data['obj_id']);
         $role_obj->changeExistingObjects(
             $source->getRefId(),
             $role_data['protected'] ? ilObjRole::MODE_PROTECTED_DELETE_LOCAL_POLICIES : ilObjRole::MODE_UNPROTECTED_DELETE_LOCAL_POLICIES,
             array('all')
         );
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilDidacticTemplateLocalPolicyAction::delete ( )

delete action filter ilDB $ilDB

Returns: bool

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

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

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         parent::delete();
 
         $query = 'DELETE FROM didactic_tpl_alp ' .
             'WHERE action_id  = ' . $ilDB->quote($this->getActionId(), 'integer');
         $ilDB->manipulate($query);
 
         foreach ($this->getFilterPattern() as $pattern) {
             $pattern->delete();
         }
         return true;
     }

Here is the call graph for this function:

◆ getFilterPattern()

ilDidacticTemplateLocalPolicyAction::getFilterPattern ( )

Get filter pattern.

Returns: array

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

References $pattern.

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

     {
         return $this->pattern;
     }

Here is the caller graph for this function:

◆ getFilterType()

ilDidacticTemplateLocalPolicyAction::getFilterType ( )

Get filter type.

Returns: int

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

References $filter_type.

Referenced by save(), and toXml().

     {
         return $this->filter_type;
     }

Here is the caller graph for this function:

◆ getRoleTemplateId()

ilDidacticTemplateLocalPolicyAction::getRoleTemplateId ( )

Get role template id.

Returns: int

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

References $role_template_id.

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

     {
         return $this->role_template_id;
     }

Here is the caller graph for this function:

◆ getRoleTemplateType()

ilDidacticTemplateLocalPolicyAction::getRoleTemplateType ( )

Get role template type.

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

References $role_template_type.

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

     {
         return $this->role_template_type;
     }

Here is the caller graph for this function:

◆ getType()

ilDidacticTemplateLocalPolicyAction::getType ( )

Get action type.

Returns: int

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

     {
         return self::TYPE_LOCAL_POLICY;
     }

◆ read()

ilDidacticTemplateLocalPolicyAction::read ( )

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

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

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         if (!parent::read()) {
             return false;
         }
 
         $query = 'SELECT * FROM didactic_tpl_alp ' .
             'WHERE action_id = ' . $ilDB->quote($this->getActionId());
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $this->setFilterType($row->filter_type);
             $this->setRoleTemplateType($row->template_type);
             $this->setRoleTemplateId($row->template_id);
         }
 
         // Read filter
         include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateFilterPatternFactory.php';
         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 ( )

Revert action.

ilRbacReview

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

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

     {
         global $DIC;
 
         $rbacadmin = $DIC['rbacadmin'];
         $tree = $DIC['tree'];
         $rbacreview = $GLOBALS['DIC']->rbac()->review();
 
         $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 (!$rbacreview->isGlobalRole($role['obj_id']) and
                 $rbacreview->isAssignable($role['obj_id'], $source->getRefId()) and
                 $rbacreview->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
                 $rbacadmin->deleteLocalRole($role_id, $source->getRefId());
                 // Change existing object
                 include_once './Services/AccessControl/classes/class.ilObjRole.php';
                 $role_obj = new ilObjRole($role_id);
                 
                 $protected = $rbacreview->isProtected($role['parent'], $role['rol_id']);
                 
                 $role_obj->changeExistingObjects(
                     $source->getRefId(),
                     $protected ?
                         ilObjRole::MODE_PROTECTED_DELETE_LOCAL_POLICIES :
                         ilObjRole::MODE_UNPROTECTED_DELETE_LOCAL_POLICIES,
                     array('all')
                 );
             }
         }
         return true;
     }

Here is the call graph for this function:

◆ revertLocalPolicy()

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

protected

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

References $DIC, $ilDB, $query, $res, $row, ilDBConstants\FETCHMODE_OBJECT, ilLoggerFactory\getLogger(), ilObject\getRefId(), ilObjRole\MODE_PROTECTED_DELETE_LOCAL_POLICIES, and ilObjRole\MODE_UNPROTECTED_DELETE_LOCAL_POLICIES.

Referenced by revert().

     {
         global $DIC;
 
         $rbacadmin = $DIC['rbacadmin'];
         $rbacreview = $DIC['rbacreview'];
         $ilDB = $DIC['ilDB'];
 
         ilLoggerFactory::getLogger('otpl')->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 (substr($role['title'], 0, 3) != 'il_') {
             ilLoggerFactory::getLogger('otpl')->warning('Cannot revert local policy for role ' . $role['title']);
             return false;
         }
 
 
         // No local policies
         if (!$rbacreview->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 = ' . $ilDB->quote($rolt_title, 'text') . ' ' .
             'AND type = ' . $ilDB->quote('rolt', 'text');
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $rolt_id = $row->obj_id;
         }
 
         // No template found
         if (!$rolt_id) {
             return false;
         }
 
         $rbacadmin->copyRoleTemplatePermissions(
             $rolt_id,
             ROLE_FOLDER_ID,
             $source->getRefId(),
             $role['obj_id'],
             true
         );
 
         // Change existing object
         include_once './Services/AccessControl/classes/class.ilObjRole.php';
         $role_obj = new ilObjRole($role['obj_id']);
         $role_obj->changeExistingObjects(
             $source->getRefId(),
             $role['protected'] ? ilObjRole::MODE_PROTECTED_DELETE_LOCAL_POLICIES : ilObjRole::MODE_UNPROTECTED_DELETE_LOCAL_POLICIES,
             array('all')
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilDidacticTemplateLocalPolicyAction::save ( )

Save action.

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

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

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         parent::save();
 
         $query = 'INSERT INTO didactic_tpl_alp (action_id,filter_type,template_type,template_id) ' .
             'VALUES( ' .
             $ilDB->quote($this->getActionId(), 'integer') . ', ' .
             $ilDB->quote($this->getFilterType(), 'integer') . ', ' .
             $ilDB->quote($this->getRoleTemplateType(), 'integer') . ', ' .
             $ilDB->quote($this->getRoleTemplateId(), 'integer') . ' ' .
             ')';
         $ilDB->manipulate($query);
 
         foreach ($this->getFilterPattern() as $pattern) {
             /* @var ilDidacticTemplateFilterPattern $pattern */
             $pattern->setParentId($this->getActionId());
             $pattern->setParentType(self::PATTERN_PARENT_TYPE);
             $pattern->save();
         }
     }

Here is the call graph for this function:

◆ setFilterPatterns()

ilDidacticTemplateLocalPolicyAction::setFilterPatterns ( array $patterns )

Set filter patterns.

Parameters

array $patterns

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

Referenced by __clone().

     {
         $this->pattern = $patterns;
     }

Here is the caller graph for this function:

◆ setFilterType()

ilDidacticTemplateLocalPolicyAction::setFilterType ( $a_type )

Set filter type.

Parameters

int $a_type

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

References $a_type.

Referenced by read().

     {
         $this->filter_type = $a_type;
     }

Here is the caller graph for this function:

◆ setRoleTemplateId()

ilDidacticTemplateLocalPolicyAction::setRoleTemplateId ( $a_id )

Set role template id.

Parameters

int $a_id

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

Referenced by read().

     {
         $this->role_template_id = $a_id;
     }

Here is the caller graph for this function:

◆ setRoleTemplateType()

ilDidacticTemplateLocalPolicyAction::setRoleTemplateType ( $a_tpl_type )

Set Role template type.

Parameters

int $a_tpl_type

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

Referenced by read().

     {
         $this->role_template_type = $a_tpl_type;
     }

Here is the caller graph for this function:

◆ toXml()

ilDidacticTemplateLocalPolicyAction::toXml ( ilXmlWriter $writer )

Export to xml.

Parameters

ilXmlWriter $writer

Returns: void

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

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

     {
         $writer->xmlStartTag('localPolicyAction');
 
         switch ($this->getFilterType()) {
             case self::FILTER_SOURCE_TITLE:
                 $writer->xmlStartTag('roleFilter', ['source' => 'title']);
                 break;
 
             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;
 
             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',
                     array(
                         'type' => 'overwrite',
                         'id' => $il_role_id
                     )
                 );
                 break;
 
             case self::TPL_ACTION_INTERSECT:
                 $writer->xmlStartTag(
                     'localPolicyTemplate',
                     array(
                         'type' => 'intersect',
                         'id' => $il_role_id
                     )
                 );
                 break;
 
             case self::TPL_ACTION_UNION:
                 $writer->xmlStartTag(
                     'localPolicyTemplate',
                     array(
                         'type' => 'union',
                         'id' => $il_role_id
                     )
                 );
                 break;
         }
 
         include_once './Services/AccessControl/classes/class.ilRoleXmlExport.php';
         $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');
         return;
     }