ilDidacticTemplateLocalRoleAction Class Reference

represents a creation of local roles action More...

Inheritance diagram for ilDidacticTemplateLocalRoleAction:

Collaboration diagram for ilDidacticTemplateLocalRoleAction:

Public Member Functions
	__construct (int $a_action_id=0)
	getType ()
	setRoleTemplateId (int $a_role_template_id)
	getRoleTemplateId ()
	apply ()
	revert ()
	save ()
	delete ()
	toXml (ilXmlWriter $writer)
	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)

Private Attributes
int	$role_template_id = 0

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 Member Functions inherited from ilDidacticTemplateAction
	initSourceObject ()
	filterRoles (ilObject $source)
Protected Attributes inherited from ilDidacticTemplateAction
ilLogger	$logger
ilDBInterface	$db
ilRbacReview	$review
ilRbacAdmin	$admin

Detailed Description

represents a creation of local roles action

Author

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

Definition at line 25 of file class.ilDidacticTemplateLocalRoleAction.php.

Constructor & Destructor Documentation

__construct()

ilDidacticTemplateLocalRoleAction::__construct

(

int

$a_action_id = 0

)

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

References ILIAS\GlobalScreen\Provider\__construct().

    {
        parent::__construct($a_action_id);
    }

Here is the call graph for this function:

Member Function Documentation

apply()

ilDidacticTemplateLocalRoleAction::apply

(

)

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

References ilObject\_lookupDescription(), ilObject\_lookupTitle(), ilDidacticTemplateAction\getRefId(), getRoleTemplateId(), ilDidacticTemplateAction\initSourceObject(), ILIAS\Repository\logger(), and ROLE_FOLDER_ID.

                           : bool
    {
        $source = $this->initSourceObject();

        $role = new ilObjRole();
        $role->setTitle(ilObject::_lookupTitle($this->getRoleTemplateId()) . '_' . $this->getRefId());
        $role->setDescription(ilObject::_lookupDescription($this->getRoleTemplateId()));
        $role->create();
        $this->admin->assignRoleToFolder($role->getId(), $source->getRefId(), "y");
        $this->logger->info(
            'Using rolt: ' .
            $this->getRoleTemplateId() .
            ' with title "' .
            ilObject::_lookupTitle($this->getRoleTemplateId()) .
            '". '
        );

        // Copy template permissions

        $this->logger->debug(
            'Copy role template permissions ' .
            'tpl_id: ' . $this->getRoleTemplateId() . ' ' .
            'parent: ' . ROLE_FOLDER_ID . ' ' .
            'role_id: ' . $role->getId() . ' ' .
            'role_parent: ' . $source->getRefId()
        );

        $this->admin->copyRoleTemplatePermissions(
            $this->getRoleTemplateId(),
            ROLE_FOLDER_ID,
            $source->getRefId(),
            $role->getId(),
            true
        );
        // Set permissions
        $ops = $this->review->getOperationsOfRole($role->getId(), $source->getType(), $source->getRefId());
        $this->admin->grantPermission($role->getId(), $ops, $source->getRefId());

        return true;
    }

Here is the call graph for this function:

delete()

ilDidacticTemplateLocalRoleAction::delete

(

)

Definition at line 114 of file class.ilDidacticTemplateLocalRoleAction.php.

References ilDidacticTemplateAction\getActionId().

                            : void
    {
        parent::delete();

        $query = 'DELETE FROM didactic_tpl_alr ' .
            'WHERE action_id = ' . $this->db->quote($this->getActionId(), 'integer');
        $this->db->manipulate($query);
    }

Here is the call graph for this function:

getRoleTemplateId()

ilDidacticTemplateLocalRoleAction::getRoleTemplateId

(

)

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

References $role_template_id.

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

                                       : int
    {
        return $this->role_template_id;
    }

Here is the caller graph for this function:

getType()

ilDidacticTemplateLocalRoleAction::getType

(

)

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

                             : int
    {
        return self::TYPE_LOCAL_ROLE;
    }

read()

ilDidacticTemplateLocalRoleAction::read

(

)

Definition at line 145 of file class.ilDidacticTemplateLocalRoleAction.php.

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

                          : void
    {
        parent::read();
        $query = 'SELECT * FROM didactic_tpl_alr ' .
            'WHERE action_id = ' . $this->db->quote($this->getActionId(), 'integer');
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->setRoleTemplateId((int) $row->role_template_id);
        }
    }

Here is the call graph for this function:

revert()

ilDidacticTemplateLocalRoleAction::revert

(

)

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

                            : bool
    {
        // @todo: revert could delete the generated local role. But on the other hand all users
        // assigned to this local role would be deassigned. E.g. if course or group membership
        // is handled by didactic templates, all members would get lost.
        return false;
    }

save()

ilDidacticTemplateLocalRoleAction::save

(

)

Definition at line 98 of file class.ilDidacticTemplateLocalRoleAction.php.

References $res, ilDidacticTemplateAction\getActionId(), and getRoleTemplateId().

                          : int
    {
        if (!parent::save()) {
            return 0;
        }

        $query = 'INSERT INTO didactic_tpl_alr (action_id,role_template_id) ' .
            'VALUES ( ' .
            $this->db->quote($this->getActionId(), 'integer') . ', ' .
            $this->db->quote($this->getRoleTemplateId(), 'integer') . ' ' .
            ') ';
        $res = $this->db->manipulate($query);

        return $this->getActionId();
    }

Here is the call graph for this function:

setRoleTemplateId()

ilDidacticTemplateLocalRoleAction::setRoleTemplateId

(

int

$a_role_template_id

)

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

Referenced by read().

                                                              : void
    {
        $this->role_template_id = $a_role_template_id;
    }

Here is the caller graph for this function:

toXml()

ilDidacticTemplateLocalRoleAction::toXml

(

ilXmlWriter

$writer

)

Definition at line 123 of file class.ilDidacticTemplateLocalRoleAction.php.

References ilObject\_lookupType(), ilXmlWriter\appendXML(), getRoleTemplateId(), IL_INST_ID, ilRoleXmlExport\MODE_DTPL, ROLE_FOLDER_ID, ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

                                              : void
    {
        $writer->xmlStartTag('localRoleAction');

        $il_id = 'il_' . IL_INST_ID . '_' . ilObject::_lookupType($this->getRoleTemplateId()) . '_' . $this->getRoleTemplateId();

        $writer->xmlStartTag(
            'roleTemplate',
            [
                'id' => $il_id
            ]
        );

        $exp = new ilRoleXmlExport();
        $exp->setMode(ilRoleXmlExport::MODE_DTPL);
        $exp->addRole($this->getRoleTemplateId(), ROLE_FOLDER_ID);
        $exp->write();
        $writer->appendXML($exp->xmlDumpMem(false));
        $writer->xmlEndTag('roleTemplate');
        $writer->xmlEndTag('localRoleAction');
    }

Here is the call graph for this function:

Field Documentation

$role_template_id

int ilDidacticTemplateLocalRoleAction::$role_template_id = 0

private

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

Referenced by getRoleTemplateId().

---

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

• components/ILIAS/DidacticTemplate/classes/Action/class.ilDidacticTemplateLocalRoleAction.php