Abstract class for template actions. More...

Inheritance diagram for ilDidacticTemplateAction:

Collaboration diagram for ilDidacticTemplateAction:

Public Member Functions
	__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	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
	initSourceObject ()
	Init the source object. More...

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

Private Attributes
	$logger = null

	$action_id = 0

	$tpl_id = 0

	$type = 0

	$ref_id = 0

Detailed Description

Abstract class for template actions.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilDidacticTemplateAction::__construct ( $action_id = 0 )

Constructor.

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

References $action_id, $DIC, read(), and setActionId().

     {
         global $DIC;
 
         $this->logger = $DIC->logger()->otpl();
         
         $this->setActionId($action_id);
         $this->read();
     }

Here is the call graph for this function:

Member Function Documentation

◆ __clone()

ilDidacticTemplateAction::__clone ( )

Clone method.

Definition at line 209 of file class.ilDidacticTemplateAction.php.

References setActionId(), and toXml().

     {
         $this->setActionId(0);
     }

Here is the call graph for this function:

◆ apply()

ilDidacticTemplateAction::apply ( )

abstract

Apply action.

Returns: bool

Referenced by read().

Here is the caller graph for this function:

◆ delete()

ilDidacticTemplateAction::delete ( )

Delete didactic template action overwrite for filling additional db fields.

Returns: bool

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

References $DIC, $ilDB, $query, and getActionId().

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $query = 'DELETE FROM didactic_tpl_a ' .
             'WHERE id = ' . $ilDB->quote($this->getActionId(), 'integer');
         $ilDB->manipulate($query);
     }

Here is the call graph for this function:

◆ filterRoles()

ilDidacticTemplateAction::filterRoles ( ilObject $source )

protected

Filter roles.

Parameters

ilObject $object

Definition at line 237 of file class.ilDidacticTemplateAction.php.

References $DIC, ilObject\_lookupTitle(), getActionId(), ilLoggerFactory\getLogger(), ilObject\getRefId(), and ilDidacticTemplateFilterPatternFactory\lookupPatternsByParentId().

Referenced by ilDidacticTemplateBlockRoleAction\apply(), ilDidacticTemplateLocalPolicyAction\apply(), ilDidacticTemplateBlockRoleAction\revert(), and ilDidacticTemplateLocalPolicyAction\revert().

     {
         global $DIC;
 
         $rbacreview = $DIC['rbacreview'];
 
         include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateFilterPatternFactory.php';
         $patterns = ilDidacticTemplateFilterPatternFactory::lookupPatternsByParentId(
             $this->getActionId(),
             self::PATTERN_PARENT_TYPE
         );
 
         $filtered = array();
         foreach ($rbacreview->getParentRoleIds($source->getRefId()) as $role_id => $role) {
             switch ($this->getFilterType()) {
                 case self::FILTER_PARENT_ROLES:
                     
                     ilLoggerFactory::getLogger('dtpl')->dump($role);
                     if (
                         ($role['parent'] == $source->getRefId()) &&
                         ($role['assign'] == 'y')
                     ) {
                         ilLoggerFactory::getLogger('dtpl')->debug('Excluding local role: ' . $role['title']);
                         break;
                     }
                     foreach ($patterns as $pattern) {
                         if ($pattern->valid(ilObject::_lookupTitle($role_id))) {
                             ilLoggerFactory::getLogger('otpl')->debug('Role is valid: ' . ilObject::_lookupTitle($role_id));
                             $filtered[$role_id] = $role;
                         }
                     }
                     break;
 
                 case self::FILTER_LOCAL_ROLES:
 
                     if (
                         $role['parent'] != $source->getRefId() ||
                         $role['assign'] == 'n'
                     ) {
                         $this->logger->debug('Excluding non local role' . $role['title']);
                         break;
                     }
                     foreach ($patterns as $pattern) {
                         if ($pattern->valid(\ilObject::_lookupTitle($role_id))) {
                             $this->logger->debug('Role is valid ' . \ilObject::_lookupTitle($role_id));
                             $filtered[$role_id] = $role;
                         }
                     }
                     break;
                 
                 default:
                 case self::FILTER_SOURCE_TITLE:
                     foreach ($patterns as $pattern) {
                         if ($pattern->valid(ilObject::_lookupTitle($role_id))) {
                             ilLoggerFactory::getLogger('otpl')->debug('Role is valid: ' . ilObject::_lookupTitle($role_id));
                             $filtered[$role_id] = $role;
                         }
                     }
                     break;
             }
         }
         return $filtered;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActionId()

ilDidacticTemplateAction::getActionId ( )

Get action id.

Returns: int

Definition at line 62 of file class.ilDidacticTemplateAction.php.

References $action_id.

Referenced by ilDidacticTemplateBlockRoleAction\delete(), ilDidacticTemplateLocalRoleAction\delete(), ilDidacticTemplateLocalPolicyAction\delete(), delete(), filterRoles(), read(), ilDidacticTemplateLocalRoleAction\read(), ilDidacticTemplateBlockRoleAction\read(), ilDidacticTemplateLocalPolicyAction\read(), ilDidacticTemplateBlockRoleAction\save(), ilDidacticTemplateLocalRoleAction\save(), ilDidacticTemplateLocalPolicyAction\save(), and save().

     {
         return $this->action_id;
     }

Here is the caller graph for this function:

◆ getLogger()

ilDidacticTemplateAction::getLogger ( )

Get logger.

Returns

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

References $logger.

Referenced by ilDidacticTemplateLocalPolicyAction\apply(), ilDidacticTemplateLocalPolicyAction\createLocalPolicy(), and ilDidacticTemplateLocalPolicyAction\revert().

     {
         return $this->logger;
     }

Here is the caller graph for this function:

◆ getRefId()

ilDidacticTemplateAction::getRefId ( )

Get ref id of target object.

Definition at line 117 of file class.ilDidacticTemplateAction.php.

References $ref_id.

Referenced by ilDidacticTemplateLocalRoleAction\apply(), and initSourceObject().

     {
         return $this->ref_id;
     }

Here is the caller graph for this function:

◆ getTemplateId()

ilDidacticTemplateAction::getTemplateId ( )

Get template id.

Returns: int

Definition at line 99 of file class.ilDidacticTemplateAction.php.

References $tpl_id.

Referenced by save().

     {
         return $this->tpl_id;
     }

Here is the caller graph for this function:

◆ getType()

ilDidacticTemplateAction::getType ( )

abstract

Get type of template.

Returns: int $type

Referenced by read(), and save().

Here is the caller graph for this function:

◆ initSourceObject()

ilDidacticTemplateAction::initSourceObject ( )

protected

Init the source object.

Returns: ilObject $obj

Definition at line 226 of file class.ilDidacticTemplateAction.php.

References $s, ilObjectFactory\getInstanceByRefId(), and getRefId().

Referenced by ilDidacticTemplateLocalRoleAction\apply(), ilDidacticTemplateBlockRoleAction\apply(), ilDidacticTemplateLocalPolicyAction\apply(), ilDidacticTemplateBlockRoleAction\revert(), and ilDidacticTemplateLocalPolicyAction\revert().

     {
         include_once './Services/Object/classes/class.ilObjectFactory.php';
         $s = ilObjectFactory::getInstanceByRefId($this->getRefId(), false);
         return $s;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilDidacticTemplateAction::read ( )

ilDB $ilDB

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

References $DIC, $ilDB, $query, $res, $row, apply(), ilDBConstants\FETCHMODE_OBJECT, getActionId(), getType(), revert(), and setTemplateId().

Referenced by __construct().

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $query = 'SELECT * FROM didactic_tpl_a ' .
             'WHERE id = ' . $ilDB->quote($this->getActionId(), 'integer');
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $this->setTemplateId($row->tpl_id);
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ revert()

ilDidacticTemplateAction::revert ( )

abstract

Implement everthing that is necessary to revert a didactic template.

return bool

Referenced by read().

Here is the caller graph for this function:

◆ save()

ilDidacticTemplateAction::save ( )

write action to db overwrite for filling additional db fields

Returns: bool

Definition at line 128 of file class.ilDidacticTemplateAction.php.

References $DIC, $ilDB, $query, getActionId(), getTemplateId(), getType(), and setActionId().

     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         if ($this->getActionId()) {
             return false;
         }
 
         $this->setActionId($ilDB->nextId('didactic_tpl_a'));
         $query = 'INSERT INTO didactic_tpl_a (id, tpl_id, type_id) ' .
             'VALUES( ' .
             $ilDB->quote($this->getActionId(), 'integer') . ', ' .
             $ilDB->quote($this->getTemplateId(), 'integer') . ', ' .
             $ilDB->quote($this->getType(), 'integer') .
             ')';
         $ilDB->manipulate($query);
         return $this->getActionId();
     }

Here is the call graph for this function:

◆ setActionId()

ilDidacticTemplateAction::setActionId ( $a_action_id )

Set action id.

Parameters

int $a_action_id

Definition at line 71 of file class.ilDidacticTemplateAction.php.

Referenced by __clone(), __construct(), and save().

     {
         $this->action_id = $a_action_id;
     }

Here is the caller graph for this function:

◆ setRefId()

ilDidacticTemplateAction::setRefId ( $a_ref_id )

Set ref id of target object.

Parameters

int	ref id void

Definition at line 109 of file class.ilDidacticTemplateAction.php.

     {
         $this->ref_id = $a_ref_id;
     }

◆ setTemplateId()

ilDidacticTemplateAction::setTemplateId ( $a_id )

Set template id.

Parameters

int $a_id

Definition at line 90 of file class.ilDidacticTemplateAction.php.

Referenced by read().

     {
         $this->tpl_id = $a_id;
     }

Here is the caller graph for this function:

◆ setType()

ilDidacticTemplateAction::setType ( $a_type_id )

Set type id.

Parameters

int ref id

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

     {
         $this->type = $a_type_id;
     }

◆ toXml()

ilDidacticTemplateAction::toXml ( ilXmlWriter $writer )

abstract

Write xml for export.

Referenced by __clone().

Here is the caller graph for this function:

Field Documentation

◆ $action_id

ilDidacticTemplateAction::$action_id = 0

private

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

Referenced by ilDidacticTemplateBlockRoleAction\__construct(), ilDidacticTemplateLocalPolicyAction\__construct(), __construct(), and getActionId().

◆ $logger

ilDidacticTemplateAction::$logger = null

private

Definition at line 26 of file class.ilDidacticTemplateAction.php.

Referenced by getLogger().

◆ $ref_id

ilDidacticTemplateAction::$ref_id = 0

private

Definition at line 33 of file class.ilDidacticTemplateAction.php.

Referenced by getRefId().

◆ $tpl_id

ilDidacticTemplateAction::$tpl_id = 0

private

Definition at line 29 of file class.ilDidacticTemplateAction.php.

Referenced by getTemplateId().

◆ $type

ilDidacticTemplateAction::$type = 0

private

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

◆ FILTER_LOCAL_ROLES

const ilDidacticTemplateAction::FILTER_LOCAL_ROLES = 4

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

Referenced by ilDidacticTemplateImport\parseActions().

◆ FILTER_PARENT_ROLES

const ilDidacticTemplateAction::FILTER_PARENT_ROLES = 3

Definition at line 18 of file class.ilDidacticTemplateAction.php.

Referenced by ilDidacticTemplateImport\parseActions().

◆ FILTER_SOURCE_OBJ_ID

const ilDidacticTemplateAction::FILTER_SOURCE_OBJ_ID = 2

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

Referenced by ilDidacticTemplateImport\parseActions().

◆ FILTER_SOURCE_TITLE

const ilDidacticTemplateAction::FILTER_SOURCE_TITLE = 1

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

Referenced by ilDidacticTemplateImport\parseActions().

◆ PATTERN_PARENT_TYPE

const ilDidacticTemplateAction::PATTERN_PARENT_TYPE = 'action'

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

◆ TYPE_BLOCK_ROLE

const ilDidacticTemplateAction::TYPE_BLOCK_ROLE = 3

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

Referenced by ilDidacticTemplateActionFactory\factoryByType(), and ilDidacticTemplateActionFactory\factoryByTypeAndId().

◆ TYPE_LOCAL_POLICY

const ilDidacticTemplateAction::TYPE_LOCAL_POLICY = 1

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

Referenced by ilDidacticTemplateActionFactory\factoryByType(), and ilDidacticTemplateActionFactory\factoryByTypeAndId().

◆ TYPE_LOCAL_ROLE

const ilDidacticTemplateAction::TYPE_LOCAL_ROLE = 2

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

Referenced by ilDidacticTemplateActionFactory\factoryByType(), and ilDidacticTemplateActionFactory\factoryByTypeAndId().

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

Services/DidacticTemplate/classes/class.ilDidacticTemplateAction.php

Public Member Functions

Data Fields

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __clone()

◆ apply()

◆ delete()

◆ filterRoles()

◆ getActionId()

◆ getLogger()

◆ getRefId()

◆ getTemplateId()

◆ getType()

◆ initSourceObject()

◆ read()

◆ revert()

◆ save()

◆ setActionId()

◆ setRefId()

◆ setTemplateId()

◆ setType()

◆ toXml()

Field Documentation

◆ $action_id

◆ $logger

◆ $ref_id

◆ $tpl_id

◆ $type

◆ FILTER_LOCAL_ROLES

◆ FILTER_PARENT_ROLES

◆ FILTER_SOURCE_OBJ_ID

◆ FILTER_SOURCE_TITLE

◆ PATTERN_PARENT_TYPE

◆ TYPE_BLOCK_ROLE

◆ TYPE_LOCAL_POLICY

◆ TYPE_LOCAL_ROLE