Abstract class for template actions. More...

Inheritance diagram for ilDidacticTemplateAction:

Collaboration diagram for ilDidacticTemplateAction:

Public Member Functions
	__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	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 ()

	filterRoles (ilObject $source)

Protected Attributes
ilLogger	$logger

ilDBInterface	$db

ilRbacReview	$review

ilRbacAdmin	$admin

Private Attributes
int	$action_id = 0

int	$tpl_id = 0

int	$type = 0

int	$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 25 of file class.ilDidacticTemplateAction.php.

Constructor & Destructor Documentation

◆ __construct()

ilDidacticTemplateAction::__construct ( int $action_id = 0 )

Reimplemented in ilDidacticTemplateLocalRoleAction, ilDidacticTemplateBlockRoleAction, and ilDidacticTemplateLocalPolicyAction.

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

    {
        global $DIC;
 
        $this->logger = $DIC->logger()->otpl();
        $this->db = $DIC->database();
        $this->review = $DIC->rbac()->review();
        $this->admin = $DIC->rbac()->admin();
 
        $this->setActionId($action_id);
        $this->read();
    }

References $DIC, ILIAS\Repository\logger(), read(), and setActionId().

Here is the call graph for this function:

Member Function Documentation

◆ __clone()

ilDidacticTemplateAction::__clone ( )

Reimplemented in ilDidacticTemplateBlockRoleAction, and ilDidacticTemplateLocalPolicyAction.

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

    {
        $this->setActionId(0);
    }

References setActionId().

Here is the call graph for this function:

◆ apply()

ilDidacticTemplateAction::apply ( )

abstract

Apply action.

Returns: bool

Reimplemented in ilDidacticTemplateBlockRoleAction, ilDidacticTemplateLocalPolicyAction, and ilDidacticTemplateLocalRoleAction.

◆ delete()

ilDidacticTemplateAction::delete ( )

Delete didactic template action Overwrite for filling additional db fields.

Reimplemented in ilDidacticTemplateBlockRoleAction, ilDidacticTemplateLocalPolicyAction, and ilDidacticTemplateLocalRoleAction.

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

                            : void
    {
        $query = 'DELETE FROM didactic_tpl_a ' .
            'WHERE id = ' . $this->db->quote($this->getActionId(), 'integer');
        $this->db->manipulate($query);
    }

References getActionId().

Here is the call graph for this function:

◆ filterRoles()

ilDidacticTemplateAction::filterRoles ( ilObject $source )

protected

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

                                                    : array
    {
        $patterns = ilDidacticTemplateFilterPatternFactory::lookupPatternsByParentId(
            $this->getActionId(),
            self::PATTERN_PARENT_TYPE
        );
 
        $filtered = array();
        foreach ($this->review->getParentRoleIds($source->getRefId()) as $role_id => $role) {
            $role_id = (int) $role_id;
            switch ($this->getFilterType()) {
                case self::FILTER_PARENT_ROLES:
                    $this->logger->dump($role);
                    if (
                        $role['assign'] === 'y' &&
                        (int) $role['parent'] === $source->getRefId()
 
                    ) {
                        $this->logger->debug('Excluding 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;
 
                case self::FILTER_LOCAL_ROLES:
                    if (
                        $role['assign'] === 'n' ||
                        (int) $role['parent'] !== $source->getRefId()
                    ) {
                        $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))) {
                            $this->logger->debug('Role is valid: ' . ilObject::_lookupTitle($role_id));
                            $filtered[$role_id] = $role;
                        }
                    }
                    break;
            }
        }
 
        return $filtered;
    }

References ilObject\_lookupTitle(), FILTER_LOCAL_ROLES, FILTER_PARENT_ROLES, FILTER_SOURCE_TITLE, getActionId(), ilObject\getRefId(), ILIAS\Repository\int(), ILIAS\Repository\logger(), and ilDidacticTemplateFilterPatternFactory\lookupPatternsByParentId().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActionId()

ilDidacticTemplateAction::getActionId ( )

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

                                 : int
    {
        return $this->action_id;
    }

References $action_id.

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

Here is the caller graph for this function:

◆ getLogger()

ilDidacticTemplateAction::getLogger ( )

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

                               : ilLogger
    {
        return $this->logger;
    }

References $logger.

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

Here is the caller graph for this function:

◆ getRefId()

ilDidacticTemplateAction::getRefId ( )

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

                              : int
    {
        return $this->ref_id;
    }

References $ref_id.

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

Here is the caller graph for this function:

◆ getTemplateId()

ilDidacticTemplateAction::getTemplateId ( )

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

                                   : int
    {
        return $this->tpl_id;
    }

References $tpl_id.

Referenced by save().

Here is the caller graph for this function:

◆ getType()

ilDidacticTemplateAction::getType ( )

abstract

Get type of template.

Returns: int $type

Reimplemented in ilDidacticTemplateBlockRoleAction, ilDidacticTemplateLocalPolicyAction, and ilDidacticTemplateLocalRoleAction.

Referenced by save().

Here is the caller graph for this function:

◆ initSourceObject()

ilDidacticTemplateAction::initSourceObject ( )

protected

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

                                         : ilObject
    {
        $s = ilObjectFactory::getInstanceByRefId($this->getRefId(), false);
        return $s;
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilDidacticTemplateAction::read ( )

Reimplemented in ilDidacticTemplateBlockRoleAction, ilDidacticTemplateLocalPolicyAction, and ilDidacticTemplateLocalRoleAction.

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

                          : void
    {
        $query = 'SELECT * FROM didactic_tpl_a ' .
            'WHERE id = ' . $this->db->quote($this->getActionId(), 'integer');
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->setTemplateId((int) $row->tpl_id);
        }
    }

References $res, ilDBConstants\FETCHMODE_OBJECT, getActionId(), and setTemplateId().

Referenced by __construct().

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.

Reimplemented in ilDidacticTemplateBlockRoleAction, ilDidacticTemplateLocalPolicyAction, and ilDidacticTemplateLocalRoleAction.

◆ save()

ilDidacticTemplateAction::save ( )

Write action to db Overwrite for filling additional db fields.

Returns: int

Reimplemented in ilDidacticTemplateBlockRoleAction, ilDidacticTemplateLocalPolicyAction, and ilDidacticTemplateLocalRoleAction.

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

                          : int
    {
        if ($this->getActionId()) {
            return 0;
        }
 
        $this->setActionId($this->db->nextId('didactic_tpl_a'));
        $query = 'INSERT INTO didactic_tpl_a (id, tpl_id, type_id) ' .
            'VALUES( ' .
            $this->db->quote($this->getActionId(), 'integer') . ', ' .
            $this->db->quote($this->getTemplateId(), 'integer') . ', ' .
            $this->db->quote($this->getType(), 'integer') .
            ')';
        $this->db->manipulate($query);
 
        return $this->getActionId();
    }

References getActionId(), getTemplateId(), getType(), and setActionId().

Here is the call graph for this function:

◆ setActionId()

ilDidacticTemplateAction::setActionId ( int $a_action_id )

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

                                                 : void
    {
        $this->action_id = $a_action_id;
    }

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

Here is the caller graph for this function:

◆ setRefId()

ilDidacticTemplateAction::setRefId ( int $a_ref_id )

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

                                           : void
    {
        $this->ref_id = $a_ref_id;
    }

◆ setTemplateId()

ilDidacticTemplateAction::setTemplateId ( int $a_id )

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

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

Referenced by read().

Here is the caller graph for this function:

◆ setType()

ilDidacticTemplateAction::setType ( int $a_type_id )

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

                                           : void
    {
        $this->type = $a_type_id;
    }

◆ toXml()

ilDidacticTemplateAction::toXml ( ilXmlWriter $writer )

abstract

Reimplemented in ilDidacticTemplateBlockRoleAction, ilDidacticTemplateLocalPolicyAction, and ilDidacticTemplateLocalRoleAction.

Field Documentation

◆ $action_id

int ilDidacticTemplateAction::$action_id = 0

private

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

Referenced by ilDidacticTemplateBlockRoleAction\__construct(), ilDidacticTemplateLocalPolicyAction\__construct(), getActionId(), and ILIAS\UI\Implementation\Component\Table\DataRow\withDisabledAction().

◆ $admin

ilRbacAdmin ilDidacticTemplateAction::$admin

protected

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

◆ $db

ilDBInterface ilDidacticTemplateAction::$db

protected

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

◆ $logger

ilLogger ilDidacticTemplateAction::$logger

protected

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

Referenced by getLogger().

◆ $ref_id

int ilDidacticTemplateAction::$ref_id = 0

private

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

Referenced by getRefId().

◆ $review

ilRbacReview ilDidacticTemplateAction::$review

protected

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

◆ $tpl_id

int ilDidacticTemplateAction::$tpl_id = 0

private

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

Referenced by getTemplateId().

◆ $type

int ilDidacticTemplateAction::$type = 0

private

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

◆ FILTER_LOCAL_ROLES

const ilDidacticTemplateAction::FILTER_LOCAL_ROLES = 4

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

Referenced by filterRoles(), ilDidacticTemplateImport\parseLocalPolicyAction(), and ilDidacticTemplateLocalPolicyAction\toXml().

◆ FILTER_PARENT_ROLES

const ilDidacticTemplateAction::FILTER_PARENT_ROLES = 3

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

Referenced by filterRoles(), ilDidacticTemplateImport\parseBlockRoleAction(), ilDidacticTemplateImport\parseLocalPolicyAction(), ilDidacticTemplateBlockRoleAction\toXml(), and ilDidacticTemplateLocalPolicyAction\toXml().

◆ FILTER_SOURCE_OBJ_ID

const ilDidacticTemplateAction::FILTER_SOURCE_OBJ_ID = 2

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

Referenced by ilDidacticTemplateImport\parseBlockRoleAction(), ilDidacticTemplateImport\parseLocalPolicyAction(), ilDidacticTemplateBlockRoleAction\toXml(), and ilDidacticTemplateLocalPolicyAction\toXml().

◆ FILTER_SOURCE_TITLE

const ilDidacticTemplateAction::FILTER_SOURCE_TITLE = 1

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

Referenced by filterRoles(), ilDidacticTemplateImport\parseBlockRoleAction(), ilDidacticTemplateImport\parseLocalPolicyAction(), ilDidacticTemplateBlockRoleAction\toXml(), and ilDidacticTemplateLocalPolicyAction\toXml().

◆ PATTERN_PARENT_TYPE

const ilDidacticTemplateAction::PATTERN_PARENT_TYPE = 'action'

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

◆ TYPE_BLOCK_ROLE

const ilDidacticTemplateAction::TYPE_BLOCK_ROLE = 3

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

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

◆ TYPE_LOCAL_POLICY

const ilDidacticTemplateAction::TYPE_LOCAL_POLICY = 1

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

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

◆ TYPE_LOCAL_ROLE

const ilDidacticTemplateAction::TYPE_LOCAL_ROLE = 2

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

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

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

components/ILIAS/DidacticTemplate/classes/Action/class.ilDidacticTemplateAction.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

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

◆ $admin

◆ $db

◆ $logger

◆ $ref_id

◆ $review

◆ $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