Description of ilDidacticTemplateBlockRoleAction. More...

Inheritance diagram for ilDidacticTemplateBlockRoleAction:

Collaboration diagram for ilDidacticTemplateBlockRoleAction:

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...

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

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	FILTER_SOURCE_TITLE = 1

const	FILTER_SOURCE_OBJ_ID = 2

const	FILTER_PARENT_ROLES = 3

const	PATTERN_PARENT_TYPE = 'action'

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	PATTERN_PARENT_TYPE = 'action'

Protected Member Functions
	blockRole ($a_role_id, $source)
	Blo k role. More...

	deleteLocalPolicy ($a_role_id, $source)
	Delete local policy. More...

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

Detailed Description

Description of ilDidacticTemplateBlockRoleAction.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

◆ __construct()

ilDidacticTemplateBlockRoleAction::__construct ( $action_id = 0 )

Constructor.

Parameters

int $action_id

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

References ilDidacticTemplateAction\$action_id.

     {
         parent::__construct($action_id);
     }

Member Function Documentation

◆ __clone()

ilDidacticTemplateBlockRoleAction::__clone ( )

clone method

Definition at line 255 of file class.ilDidacticTemplateBlockRoleAction.php.

References $pattern, array, 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()

ilDidacticTemplateBlockRoleAction::addFilterPattern ( ilDidacticTemplateFilterPattern $pattern )

Add filter.

Parameters

ilDidacticTemplateFilterPatter $pattern

Definition at line 37 of file class.ilDidacticTemplateBlockRoleAction.php.

References $pattern.

Referenced by read().

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

Here is the caller graph for this function:

◆ apply()

ilDidacticTemplateBlockRoleAction::apply ( )

Apply action.

Definition at line 129 of file class.ilDidacticTemplateBlockRoleAction.php.

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

     {
         $source = $this->initSourceObject();
         $roles = $this->filterRoles($source);
 
         // Create local policy for filtered roles
         foreach ($roles as $role_id => $role) {
             $this->blockRole($role_id, $source);
         }
         return true;
     }

Here is the call graph for this function:

◆ blockRole()

ilDidacticTemplateBlockRoleAction::blockRole	(	$a_role_id,
		$source
	)

protected

Blo k role.

Parameters

int	$a_role_id
ilObject	$source

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

References $source.

Referenced by apply().

     {
         global $rbacadmin, $rbacreview;
         
         // Set assign to 'y' only if it is a local role
         $assign = $rbacreview->isAssignable($a_role_id, $source->getRefId()) ? 'y' : 'n';
 
         // Delete permissions
         $rbacadmin->revokeSubtreePermissions($source->getRefId(), $a_role_id);
 
         // Delete template permissions
         $rbacadmin->deleteSubtreeTemplates($source->getRefId(), $a_role_id);
 
         $rbacadmin->assignRoleToFolder(
             $a_role_id,
             $source->getRefId(),
             $assign
         );
         return true;
     }

Here is the caller graph for this function:

◆ delete()

ilDidacticTemplateBlockRoleAction::delete ( )

delete action filter ilDB $ilDB

Returns: bool

Definition at line 107 of file class.ilDidacticTemplateBlockRoleAction.php.

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

     {
         global $ilDB;
 
         parent::delete();
 
         $query = 'DELETE FROM didactic_tpl_abr ' .
             '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:

◆ deleteLocalPolicy()

ilDidacticTemplateBlockRoleAction::deleteLocalPolicy	(	$a_role_id,
		$source
	)

protected

Delete local policy.

Parameters

int	$a_role_id
ilObject	$source

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

References $source, ilObject\_lookupTitle(), array, ilLoggerFactory\getLogger(), and ilObjRole\MODE_UNPROTECTED_DELETE_LOCAL_POLICIES.

Referenced by revert().

     {
         global $rbacreview, $rbacadmin;
 
         // Create role folder if it does not exist
         //$rolf = $rbacreview->getRoleFolderIdOfObject($source->getRefId());
 
         if ($rbacreview->getRoleFolderOfRole($a_role_id) == $source->getRefId()) {
             ilLoggerFactory::getLogger('otpl')->debug('Ignoring local role: ' . ilObject::_lookupTitle($a_role_id));
             return false;
         }
 
         $rbacadmin->deleteLocalRole($a_role_id, $source->getRefId());
 
         // Change existing object
         include_once './Services/AccessControl/classes/class.ilObjRole.php';
         $role = new ilObjRole($a_role_id);
         $role->changeExistingObjects(
             $source->getRefId(),
             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:

◆ getFilterPattern()

ilDidacticTemplateBlockRoleAction::getFilterPattern ( )

Get filter pattern.

Returns: array

Definition at line 55 of file class.ilDidacticTemplateBlockRoleAction.php.

References $pattern.

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

     {
         return $this->pattern;
     }

Here is the caller graph for this function:

◆ getFilterType()

ilDidacticTemplateBlockRoleAction::getFilterType ( )

Get filter type.

Returns: int

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

References $filter_type.

Referenced by save(), and toXml().

     {
         return $this->filter_type;
     }

Here is the caller graph for this function:

◆ getType()

ilDidacticTemplateBlockRoleAction::getType ( )

Get action type.

Returns: int

Definition at line 219 of file class.ilDidacticTemplateBlockRoleAction.php.

     {
         return self::TYPE_BLOCK_ROLE;
     }

◆ read()

ilDidacticTemplateBlockRoleAction::read ( )

read action data ilDB $ilDB

Returns: bool

Definition at line 272 of file class.ilDidacticTemplateBlockRoleAction.php.

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

     {
         global $ilDB;
 
         if (!parent::read()) {
             return false;
         }
 
         $query = 'SELECT * FROM didactic_tpl_abr ' .
             'WHERE action_id = ' . $ilDB->quote($this->getActionId());
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $this->setFilterType($row->filter_type);
         }
 
         // 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()

ilDidacticTemplateBlockRoleAction::revert ( )

Revert action.

Definition at line 170 of file class.ilDidacticTemplateBlockRoleAction.php.

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

     {
         $source = $this->initSourceObject();
         $roles = $this->filterRoles($source);
 
         // Create local policy for filtered roles
         foreach ($roles as $role_id => $role) {
             $this->deleteLocalPolicy($role_id, $source);
         }
         return true;
     }

Here is the call graph for this function:

◆ save()

ilDidacticTemplateBlockRoleAction::save ( )

Save action.

Definition at line 81 of file class.ilDidacticTemplateBlockRoleAction.php.

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

     {
         global $ilDB;
 
         parent::save();
 
         $query = 'INSERT INTO didactic_tpl_abr (action_id,filter_type) ' .
             'VALUES( ' .
             $ilDB->quote($this->getActionId(), 'integer') . ', ' .
             $ilDB->quote($this->getFilterType(), '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()

ilDidacticTemplateBlockRoleAction::setFilterPatterns ( array $patterns )

Set filter patterns.

Parameters

array $patterns

Definition at line 46 of file class.ilDidacticTemplateBlockRoleAction.php.

Referenced by __clone().

     {
         $this->pattern = $patterns;
     }

Here is the caller graph for this function:

◆ setFilterType()

ilDidacticTemplateBlockRoleAction::setFilterType ( $a_type )

Set filter type.

Parameters

int $a_type

Definition at line 64 of file class.ilDidacticTemplateBlockRoleAction.php.

References $a_type.

Referenced by read().

     {
         $this->filter_type = $a_type;
     }

Here is the caller graph for this function:

◆ toXml()

ilDidacticTemplateBlockRoleAction::toXml ( ilXmlWriter $writer )

Export to xml.

Parameters

ilXmlWriter $writer

Returns: void

Definition at line 229 of file class.ilDidacticTemplateBlockRoleAction.php.

References $pattern, array, getFilterPattern(), getFilterType(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

     {
         $writer->xmlStartTag('blockRoleAction');
 
         switch ($this->getFilterType()) {
             case self::FILTER_SOURCE_OBJ_ID:
                 $writer->xmlStartTag('roleFilter', array('source' => 'objId'));
                 break;
 
             default:
             case self::FILTER_SOURCE_TITLE:
                 $writer->xmlStartTag('roleFilter', array('source' => 'title'));
                 break;
         }
 
         foreach ($this->getFilterPattern() as $pattern) {
             $pattern->toXml($writer);
         }
         $writer->xmlEndTag('roleFilter');
         $writer->xmlEndTag('blockRoleAction');
         return;
     }