Xml export of roles and role templates. More...

Inheritance diagram for ilRoleXmlExport:

Collaboration diagram for ilRoleXmlExport:

Public Member Functions
	__construct ()

	setRoles (array $a_roles)
	Set roles Format is: array(role_id => array(role_folder_id)) More...

	getRoles ()

	addRole (int $a_role_id, int $a_rolf_id)

	setMode (int $a_mode)

	getMode ()

	writeHeader ()
	Write xml header. More...

	write ()
	Write xml presentation of chosen roles. More...

Public Member Functions inherited from ilXmlWriter
	__construct (string $version="1.0", string $outEnc="utf-8", string $inEnc="utf-8")

	xmlSetDtdDef (string $dtdDef)
	Sets dtd definition. More...

	xmlSetGenCmt (string $genCmt)
	Sets generated comment. More...

	xmlFormatData (string $data)
	Indents text for better reading. More...

	xmlHeader ()
	Writes xml header. More...

	xmlStartTag (string $tag, ?array $attrs=null, bool $empty=false, bool $encode=true, bool $escape=true)
	Writes a starttag. More...

	xmlEndTag (string $tag)
	Writes an endtag. More...

	xmlData (string $data, bool $encode=true, bool $escape=true)
	Writes data. More...

	xmlElement (string $tag, $attrs=null, $data=null, $encode=true, $escape=true)
	Writes a basic element (no children, just textual content) More...

	xmlDumpFile (string $file, bool $format=true)
	Dumps xml document from memory into a file. More...

	xmlDumpMem (bool $format=true)
	Returns xml document from memory. More...

	appendXML (string $a_str)
	append xml string to document More...

	xmlClear ()
	clears xmlStr More...

Data Fields
const	MODE_DTPL = 1

Protected Attributes
ilRbacReview	$rbacreview

Private Member Functions
	writeRole (int $a_role_id, int $a_rolf)
	Write xml presentation of one role. More...

	initRbacOperations ()
	Cache rbac operations. More...

Private Attributes
array	$roles = []

array	$operations = []

int	$mode = 0

Detailed Description

Xml export of roles and role templates.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilRoleXmlExport::__construct ( )

Definition at line 35 of file class.ilRoleXmlExport.php.

    {
        global $DIC;
 
        $this->rbacreview = $DIC->rbac()->review();
 
        parent::__construct();
        $this->initRbacOperations();
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and initRbacOperations().

Here is the call graph for this function:

Member Function Documentation

◆ addRole()

ilRoleXmlExport::addRole	(	int	$a_role_id,
		int	$a_rolf_id
	)

Definition at line 59 of file class.ilRoleXmlExport.php.

                                                           : void
    {
        $this->roles[$a_role_id][] = $a_rolf_id;
    }

◆ getMode()

ilRoleXmlExport::getMode ( )

Definition at line 69 of file class.ilRoleXmlExport.php.

                             : int
    {
        return $this->mode;
    }

References $mode.

Referenced by write().

Here is the caller graph for this function:

◆ getRoles()

ilRoleXmlExport::getRoles ( )

Definition at line 54 of file class.ilRoleXmlExport.php.

                              : array
    {
        return $this->roles;
    }

References $roles.

Referenced by write().

Here is the caller graph for this function:

◆ initRbacOperations()

ilRoleXmlExport::initRbacOperations ( )

private

Cache rbac operations.

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

                                         : void
    {
        foreach ($this->rbacreview->getOperations() as $operation) {
            $this->operations[$operation['ops_id']] = $operation['operation'];
        }
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setMode()

ilRoleXmlExport::setMode ( int $a_mode )

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

                                        : void
    {
        $this->mode = $a_mode;
    }

◆ setRoles()

ilRoleXmlExport::setRoles ( array $a_roles )

Set roles Format is: array(role_id => array(role_folder_id))

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

                                            : void
    {
        $this->roles = $a_roles;
    }

◆ write()

ilRoleXmlExport::write ( )

Write xml presentation of chosen roles.

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

                           : void
    {
        if ($this->getMode() != self::MODE_DTPL) {
            $this->xmlStartTag('roles');
        }
 
        foreach ($this->getRoles() as $role_id => $role_folder_ids) {
            foreach ((array) $role_folder_ids as $rolf) {
                $this->writeRole($role_id, $rolf);
            }
        }
 
        if ($this->getMode() != self::MODE_DTPL) {
            $this->xmlEndTag('roles');
        }
    }

References getMode(), getRoles(), writeRole(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Here is the call graph for this function:

◆ writeHeader()

ilRoleXmlExport::writeHeader ( )

Write xml header.

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

                                 : void
    {
        $this->xmlSetDtdDef("<!DOCTYPE Roles PUBLIC \"-//ILIAS//DTD ILIAS Roles//EN\" \"" . ILIAS_HTTP_PATH . "/components/ILIAS/Export/xml/ilias_role_definition_4_2.dtd\">");
        $this->xmlSetGenCmt("Role Definition");
        $this->xmlHeader();
    }

References ilXmlWriter\xmlHeader(), ilXmlWriter\xmlSetDtdDef(), and ilXmlWriter\xmlSetGenCmt().

Here is the call graph for this function:

◆ writeRole()

ilRoleXmlExport::writeRole	(	int	$a_role_id,
		int	$a_rolf
	)

private

Write xml presentation of one role.

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

                                                           : void
    {
        $attributes = [
            'type' => ilObject::_lookupType($a_role_id),
            'id' => 'il_' . IL_INST_ID . '_' . ilObject::_lookupType($a_role_id) . '_' . $a_role_id,
            'protected' => ($GLOBALS['DIC']['rbacreview']->isProtected($a_rolf, $a_role_id) ? 1 : 0)
        ];
 
        $this->xmlStartTag('role', $attributes);
 
        $this->xmlElement('title', [], ilObject::_lookupTitle($a_role_id));
        $this->xmlElement('description', [], ilObject::_lookupDescription($a_role_id));
 
        $this->xmlStartTag('operations');
        foreach ($this->rbacreview->getAllOperationsOfRole($a_role_id, $a_rolf) as $obj_group => $operations) {
            foreach ($operations as $ops_id) {
                if (isset($this->operations[$ops_id])) {
                    $this->xmlElement('operation', ['group' => $obj_group], trim($this->operations[$ops_id]));
                }
            }
        }
        $this->xmlEndTag('operations');
        $this->xmlEndTag('role');
    }

References $GLOBALS, $operations, ilObject\_lookupDescription(), ilObject\_lookupTitle(), ilObject\_lookupType(), IL_INST_ID, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $mode

int ilRoleXmlExport::$mode = 0

private

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

Referenced by getMode().

◆ $operations

array ilRoleXmlExport::$operations = []

private

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

Referenced by writeRole().

◆ $rbacreview

ilRbacReview ilRoleXmlExport::$rbacreview

protected

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

◆ $roles

array ilRoleXmlExport::$roles = []

private

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

Referenced by getRoles().

◆ MODE_DTPL

const ilRoleXmlExport::MODE_DTPL = 1

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

Referenced by ilDidacticTemplateLocalPolicyAction\toXml(), and ilDidacticTemplateLocalRoleAction\toXml().

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

components/ILIAS/AccessControl/classes/class.ilRoleXmlExport.php

Public Member Functions

Data Fields

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addRole()

◆ getMode()

◆ getRoles()

◆ initRbacOperations()

◆ setMode()

◆ setRoles()

◆ write()

◆ writeHeader()

◆ writeRole()

Field Documentation

◆ $mode

◆ $operations

◆ $rbacreview

◆ $roles

◆ MODE_DTPL