Description of class. More...

Collaboration diagram for ilRoleXmlImporter:

Public Member Functions
	__construct ($a_role_folder_id=0)
	Constructor. More...

	setXml ($a_xml)

	getXml ()

	getRoleFolderId ()
	Get role folder id. More...

	getRole ()
	Get role. More...

	setRole (ilObject $role)
	Set role or role template. More...

	import ()
	import role \| role templatae More...

	importSimpleXml (SimpleXMLElement $role)
	Import using simplexml. More...

Protected Member Functions
	assigntoRoleFolder ()
	Assign role to folder @global type $rbacadmin. More...

	initRole ($import_id)

	parseXmlErrors ()

Protected Attributes
	$role_folder = 0

	$role = null

	$xml = ''

Private Attributes
	$logger = null

	$refinery

Detailed Description

Description of class.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilRoleXmlImporter::__construct ( $a_role_folder_id = 0 )

Constructor.

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

    {
        global $DIC;
 
        $this->logger = $DIC->logger()->otpl();
        $this->role_folder = $a_role_folder_id;
        $this->refinery = $DIC['refinery'];
    }

References $DIC.

Member Function Documentation

◆ assigntoRoleFolder()

ilRoleXmlImporter::assigntoRoleFolder ( )

protected

Assign role to folder @global type $rbacadmin.

Returns: type

Definition at line 208 of file class.ilRoleXmlImporter.php.

    {
        global $DIC;
 
        $rbacadmin = $DIC['rbacadmin'];
        $rbacreview = $DIC['rbacreview'];
 
        if (!$this->getRoleFolderId()) {
            return;
        }
 
        if ($rbacreview->isRoleAssignedToObject($this->getRole()->getId(), $this->getRoleFolderId())) {
            return;
        }
 
        $rbacadmin->assignRoleToFolder(
            $this->getRole()->getId(),
            $this->getRoleFolderId(),
            $this->getRole() instanceof ilObjRole ? 'y' : 'n'
        );
    }

References $DIC, getRole(), and getRoleFolderId().

Here is the call graph for this function:

◆ getRole()

ilRoleXmlImporter::getRole ( )

Get role.

Returns: ilObjRole

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

    {
        return $this->role;
    }

References $role.

Referenced by assigntoRoleFolder(), importSimpleXml(), and initRole().

Here is the caller graph for this function:

◆ getRoleFolderId()

ilRoleXmlImporter::getRoleFolderId ( )

Get role folder id.

Returns: int

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

    {
        return $this->role_folder;
    }

References $role_folder.

Referenced by assigntoRoleFolder(), and importSimpleXml().

Here is the caller graph for this function:

◆ getXml()

ilRoleXmlImporter::getXml ( )

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

    {
        return $this->xml;
    }

References $xml.

Referenced by import().

Here is the caller graph for this function:

◆ import()

ilRoleXmlImporter::import ( )

import role | role templatae

Exceptions

ilRoleXmlImporterException

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

    {
        libxml_use_internal_errors(true);
 
        $root = simplexml_load_string($this->getXml());
 
        if (!$root instanceof SimpleXMLElement) {
            throw new ilRoleImporterException($this->parseXmlErrors());
        }
        foreach ($root->role as $roleElement) {
            $this->importSimpleXml($roleElement);
            // only one role is parsed
            break;
        }
    }

References getXml(), importSimpleXml(), and parseXmlErrors().

Here is the call graph for this function:

◆ importSimpleXml()

ilRoleXmlImporter::importSimpleXml ( SimpleXMLElement $role )

Import using simplexml.

Parameters

SimpleXMLElement $role

Definition at line 103 of file class.ilRoleXmlImporter.php.

    {
        global $DIC;
 
        $rbacadmin = $DIC['rbacadmin'];
        $rbacreview = $DIC['rbacreview'];
        $lng = $DIC['lng'];
 
        $import_id = (string) $role['id'];
        $this->logger->info('Importing role with import_id: ' . $import_id);
 
        if (!$this->initRole($import_id)) {
            return 0;
        }
 
        $trafo = $this->refinery->in()->series([
            $this->refinery->kindlyTo()->string(),
            $this->refinery->string()->stripTags()
        ]);
 
        $this->getRole()->setTitle($trafo->transform($role->title ?? ''));
        $this->getRole()->setDescription($trafo->transform($role->description ?? ''));
 
        $this->logger->info('Current role import id: ' . $this->getRole()->getImportId());
 
        $type = ilObject::_lookupType($this->getRoleFolderId(), true);
        $exp = explode("_", $this->getRole()->getTitle());
 
        if (count($exp) > 0 && $exp[0] === "il") {
            if (count($exp) > 1 && $exp[1] !== $type) {
                throw new ilRoleImporterException(sprintf(
                    $lng->txt("rbac_cant_import_role_wrong_type"),
                    $lng->txt('obj_' . $exp[1]),
                    $lng->txt('obj_' . $type)
                ));
            }
 
            $exp[3] = $this->getRoleFolderId();
 
            $id = ilObjRole::_getIdsForTitle(implode("_", $exp));
 
            if ($id[0]) {
                $GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': Overwrite role ' . implode("_", $exp));
                $this->getRole()->setId($id[0]);
                $this->getRole()->read();
            }
        }
 
        // Create or update
        if ($this->getRole()->getId()) {
            $rbacadmin->deleteRolePermission($this->getRole()->getId(), $this->getRoleFolderId());
            $this->getRole()->update();
        } else {
            $this->getRole()->create();
        }
 
 
        $this->assignToRoleFolder();
 
        $protected = (string) $role['protected'];
        if ($protected) {
            $rbacadmin->setProtected(0, $this->getRole()->getId(), 'y');
        }
 
        // Add operations
        $ops = $rbacreview->getOperations();
        $operations = array();
        foreach ($ops as $ope) {
            $operations[$ope['operation']] = $ope['ops_id'];
        }
 
        foreach ($role->operations as $sxml_operations) {
            foreach ($sxml_operations as $sxml_op) {
                $operation = trim((string) $sxml_op);
                if (!array_key_exists($operation, $operations)) {
                    continue;
                }
                $ops_group = (string) $sxml_op['group'];
                $ops_id = (int) $operations[$operation];
                $ops = trim((string) $sxml_op);
 
                if ($ops_group and $ops_id) {
                    $rbacadmin->setRolePermission(
                        $this->getRole()->getId(),
                        $ops_group,
                        array($ops_id),
                        $this->getRoleFolderId() // #10161
                    );
                } else {
                    $GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': Cannot create operation for...');
                    $GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': New operation for group ' . $ops_group);
                    $GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': New operation ' . $ops);
                    $GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': New operation ' . $ops_id);
                }
            }
        }
 
        return $this->getRole()->getId();
    }

References $DIC, $GLOBALS, $lng, $role, $type, ilObject\_getIdsForTitle(), ilObject\_lookupType(), getRole(), getRoleFolderId(), and initRole().

Referenced by import().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initRole()

ilRoleXmlImporter::initRole ( $import_id )

protected

Definition at line 231 of file class.ilRoleXmlImporter.php.

    {
        if ($this->getRole()) {
            return true;
        }
 
        $this->logger->debug('Searching already imported role by import_id: ' . $import_id);
        $obj_id = 0;
        if ($import_id) {
            $obj_id = ilObject::_lookupObjIdByImportId($import_id);
        }
        $this->logger->debug('Found already imported obj_id: ' . $obj_id);
 
 
        if ($obj_id) {
            $this->role = ilObjectFactory::getInstanceByObjId($obj_id, false);
        }
        if (
            (!$this->getRole() instanceof ilObjRole) &&
            (!$this->getRole() instanceof ilObjRoleTemplate)
        ) {
            $this->logger->debug('Creating new role template');
            $this->role = new ilObjRoleTemplate();
        }
        $this->role->setImportId((string) $import_id);
        return true;
    }

References ilObject\_lookupObjIdByImportId(), ilObjectFactory\getInstanceByObjId(), and getRole().

Referenced by importSimpleXml().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseXmlErrors()

ilRoleXmlImporter::parseXmlErrors ( )

protected

Definition at line 259 of file class.ilRoleXmlImporter.php.

    {
        $errors = '';
 
        foreach (libxml_get_errors() as $err) {
            $errors .= $err->code . '<br/>';
        }
        return $errors;
    }

References $errors.

Referenced by import().

Here is the caller graph for this function:

◆ setRole()

ilRoleXmlImporter::setRole ( ilObject $role )

Set role or role template.

Parameters

ilObject $role

Definition at line 73 of file class.ilRoleXmlImporter.php.

    {
        $this->role = $role;
    }

References $role.

◆ setXml()

ilRoleXmlImporter::setXml ( $a_xml )

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

    {
        $this->xml = $a_xml;
    }

Field Documentation

◆ $logger

ilRoleXmlImporter::$logger = null

private

Definition at line 22 of file class.ilRoleXmlImporter.php.

◆ $refinery

ilRoleXmlImporter::$refinery

private

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

◆ $role

ilRoleXmlImporter::$role = null

protected

Definition at line 15 of file class.ilRoleXmlImporter.php.

Referenced by getRole(), importSimpleXml(), and setRole().

◆ $role_folder

ilRoleXmlImporter::$role_folder = 0

protected

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

Referenced by getRoleFolderId().

◆ $xml

ilRoleXmlImporter::$xml = ''

protected

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

Referenced by getXml().

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

Services/AccessControl/classes/class.ilRoleXmlImporter.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ assigntoRoleFolder()

◆ getRole()

◆ getRoleFolderId()

◆ getXml()

◆ import()

◆ importSimpleXml()

◆ initRole()

◆ parseXmlErrors()

◆ setRole()

◆ setXml()

Field Documentation

◆ $logger

◆ $refinery

◆ $role

◆ $role_folder

◆ $xml