ilDidacticTemplateBlockRoleAction Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilDidacticTemplateBlockRoleAction:

Collaboration diagram for ilDidacticTemplateBlockRoleAction:

Public Member Functions
	__construct (int $action_id=0)
	addFilterPattern (ilDidacticTemplateFilterPattern $pattern)
	setFilterPatterns (array $patterns)
	Set filter patterns. More...
	getFilterPattern ()
	Get filter patterns. More...
	setFilterType (int $a_type)
	getFilterType ()
	save ()
	Write action to db Overwrite for filling additional db fields. More...
	delete ()
	Delete didactic template action Overwrite for filling additional db fields. More...
	apply ()
	Apply action. More...
	revert ()
	Implement everthing that is necessary to revert a didactic template return bool. More...
	getType ()
	Get type of template. More...
	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)

Protected Member Functions
	blockRole (int $a_role_id, ilObject $source)
	deleteLocalPolicy (int $a_role_id, ilObject $source)
Protected Member Functions inherited from ilDidacticTemplateAction
	initSourceObject ()
	filterRoles (ilObject $source)

Private Attributes
array	$pattern = []
int	$filter_type = self::FILTER_SOURCE_TITLE

Additional Inherited Members
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 Attributes inherited from ilDidacticTemplateAction
ilLogger	$logger
ilDBInterface	$db
ilRbacReview	$review
ilRbacAdmin	$admin

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 26 of file class.ilDidacticTemplateBlockRoleAction.php.

Constructor & Destructor Documentation

__construct()

ilDidacticTemplateBlockRoleAction::__construct

(

int

$action_id = 0

)

Reimplemented from ilDidacticTemplateAction.

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

    {
        parent::__construct($action_id);
    }

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

Here is the call graph for this function:

Member Function Documentation

__clone()

ilDidacticTemplateBlockRoleAction::__clone

(

)

Reimplemented from ilDidacticTemplateAction.

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

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

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

Here is the call graph for this function:

addFilterPattern()

ilDidacticTemplateBlockRoleAction::addFilterPattern

(

ilDidacticTemplateFilterPattern

$pattern

)

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

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

References $pattern.

Referenced by read().

Here is the caller graph for this function:

apply()

ilDidacticTemplateBlockRoleAction::apply

(

)

Apply action.

Returns

bool

Reimplemented from ilDidacticTemplateAction.

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

                           : bool
    {
        $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;
    }

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

Here is the call graph for this function:

blockRole()

ilDidacticTemplateBlockRoleAction::blockRole ( int  $a_role_id, ilObject  $source  )

protected

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

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

References $source, and SYSTEM_ROLE_ID.

Referenced by apply().

Here is the caller graph for this function:

delete()

ilDidacticTemplateBlockRoleAction::delete

(

)

Delete didactic template action Overwrite for filling additional db fields.

Reimplemented from ilDidacticTemplateAction.

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

                            : void
    {
        parent::delete();
        $query = 'DELETE FROM didactic_tpl_abr ' .
            'WHERE action_id  = ' . $this->db->quote($this->getActionId(), 'integer');
        $this->db->manipulate($query);
 
        foreach ($this->getFilterPattern() as $pattern) {
            $pattern->delete();
        }
    }

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

Here is the call graph for this function:

deleteLocalPolicy()

ilDidacticTemplateBlockRoleAction::deleteLocalPolicy ( int  $a_role_id, ilObject  $source  )

protected

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

                                                                          : bool
    {
        // Create role folder if it does not exist
        //$rolf = $rbacreview->getRoleFolderIdOfObject($source->getRefId());
 
        if ($this->review->getRoleFolderOfRole($a_role_id) === $source->getRefId()) {
            $this->logger->debug('Ignoring local role: ' . ilObject::_lookupTitle($a_role_id));
            return false;
        }
 
        $this->admin->deleteLocalRole($a_role_id, $source->getRefId());
 
        // Change existing object
        $role = new ilObjRole($a_role_id);
        $role->changeExistingObjects(
            $source->getRefId(),
            ilObjRole::MODE_UNPROTECTED_DELETE_LOCAL_POLICIES,
            ['all']
        );
        return true;
    }

References $source, ilObject\_lookupTitle(), ILIAS\Repository\logger(), and ilObjRole\MODE_UNPROTECTED_DELETE_LOCAL_POLICIES.

Referenced by revert().

Here is the call graph for this function:

Here is the caller graph for this function:

getFilterPattern()

ilDidacticTemplateBlockRoleAction::getFilterPattern

(

)

Get filter patterns.

Returns

ilDidacticTemplateFilterPattern[]

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

                                      : array
    {
        return $this->pattern;
    }

References $pattern.

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

Here is the caller graph for this function:

getFilterType()

ilDidacticTemplateBlockRoleAction::getFilterType

(

)

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

                                   : int
    {
        return $this->filter_type;
    }

References $filter_type.

Referenced by save(), and toXml().

Here is the caller graph for this function:

getType()

ilDidacticTemplateBlockRoleAction::getType

(

)

Get type of template.

Returns

int $type

Reimplemented from ilDidacticTemplateAction.

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

                             : int
    {
        return self::TYPE_BLOCK_ROLE;
    }

References ilDidacticTemplateAction\TYPE_BLOCK_ROLE.

read()

ilDidacticTemplateBlockRoleAction::read

(

)

Reimplemented from ilDidacticTemplateAction.

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

                          : void
    {
        parent::read();
        $query = 'SELECT * FROM didactic_tpl_abr ' .
            '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);
        }
 
        // Read filter
        foreach (ilDidacticTemplateFilterPatternFactory::lookupPatternsByParentId(
            $this->getActionId(),
            self::PATTERN_PARENT_TYPE
        ) as $pattern) {
            $this->addFilterPattern($pattern);
        }
    }

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

Here is the call graph for this function:

revert()

ilDidacticTemplateBlockRoleAction::revert

(

)

Implement everthing that is necessary to revert a didactic template return bool.

Reimplemented from ilDidacticTemplateAction.

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

                            : bool
    {
        $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;
    }

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

Here is the call graph for this function:

save()

ilDidacticTemplateBlockRoleAction::save

(

)

Write action to db Overwrite for filling additional db fields.

Returns

int

Reimplemented from ilDidacticTemplateAction.

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

                          : int
    {
        parent::save();
        $query = 'INSERT INTO didactic_tpl_abr (action_id,filter_type) ' .
            'VALUES( ' .
            $this->db->quote($this->getActionId(), \ilDBConstants::T_INTEGER) . ', ' .
            $this->db->quote($this->getFilterType(), \ilDBConstants::T_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();
    }

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

Here is the call graph for this function:

setFilterPatterns()

ilDidacticTemplateBlockRoleAction::setFilterPatterns

(

array

$patterns

)

Set filter patterns.

Parameters

ilDidacticTemplateFilterPattern[]

$patterns

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

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

Referenced by __clone().

Here is the caller graph for this function:

setFilterType()

ilDidacticTemplateBlockRoleAction::setFilterType

(

int

$a_type

)

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

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

Referenced by read().

Here is the caller graph for this function:

toXml()

ilDidacticTemplateBlockRoleAction::toXml

(

ilXmlWriter

$writer

)

Reimplemented from ilDidacticTemplateAction.

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

                                              : void
    {
        $writer->xmlStartTag('blockRoleAction');
 
        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_SOURCE_TITLE:
            default:
                $writer->xmlStartTag('roleFilter', ['source' => 'title']);
                break;
 
        }
 
        foreach ($this->getFilterPattern() as $pattern) {
            $pattern->toXml($writer);
        }
        $writer->xmlEndTag('roleFilter');
        $writer->xmlEndTag('blockRoleAction');
    }

References $pattern, ilDidacticTemplateAction\FILTER_PARENT_ROLES, ilDidacticTemplateAction\FILTER_SOURCE_OBJ_ID, ilDidacticTemplateAction\FILTER_SOURCE_TITLE, getFilterPattern(), getFilterType(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Here is the call graph for this function:

Field Documentation

$filter_type

int ilDidacticTemplateBlockRoleAction::$filter_type = self::FILTER_SOURCE_TITLE

private

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

Referenced by getFilterType().

$pattern

array ilDidacticTemplateBlockRoleAction::$pattern = []

private

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

Referenced by __clone(), addFilterPattern(), delete(), getFilterPattern(), read(), save(), and toXml().

---

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

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