Description of class. More...

Collaboration diagram for ilRoleXmlImporter:

Public Member Functions
	__construct (int $a_role_folder_id=0)

	setXml (string $a_xml)

	getXml ()

	getRoleFolderId ()

	getRole ()

	setRole (ilObject $role)

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

	importSimpleXml (SimpleXMLElement $role)

Protected Member Functions
	assignToRoleFolder ()

	initRole (string $import_id)

	parseXmlErrors ()

Protected Attributes
int	$role_folder = 0

ilObject	$role = null

string	$xml = ''

Private Attributes
ilLogger	$logger

ilRbacAdmin	$rbacadmin

ilRbacReview	$rbacreview

ilLanguage	$language

Refinery	$refinery

Detailed Description

Description of class.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilRoleXmlImporter::__construct ( int $a_role_folder_id = 0 )

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

References $DIC, ILIAS\UI\examples\Symbol\Glyph\Language\language(), ILIAS\Repository\logger(), and ILIAS\Repository\refinery().

     {
         global $DIC;
 
         $this->logger = $DIC->logger()->ac();
         $this->rbacreview = $DIC->rbac()->review();
         $this->rbacadmin = $DIC->rbac()->admin();
         $this->language = $DIC->language();
         $this->refinery = $DIC['refinery'];
 
         $this->role_folder = $a_role_folder_id;
     }

Here is the call graph for this function:

Member Function Documentation

◆ assignToRoleFolder()

ilRoleXmlImporter::assignToRoleFolder ( )

protected

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

References ILIAS\Survey\Mode\getId(), getRole(), and getRoleFolderId().

Referenced by importSimpleXml().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRole()

ilRoleXmlImporter::getRole ( )

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

References $role.

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

                              : ?ilObject
     {
         return $this->role;
     }

Here is the caller graph for this function:

◆ getRoleFolderId()

ilRoleXmlImporter::getRoleFolderId ( )

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

References $role_folder.

Referenced by assignToRoleFolder(), and importSimpleXml().

                                      : int
     {
         return $this->role_folder;
     }

Here is the caller graph for this function:

◆ getXml()

ilRoleXmlImporter::getXml ( )

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

References $xml.

Referenced by import().

                             : string
     {
         return $this->xml;
     }

Here is the caller graph for this function:

◆ import()

ilRoleXmlImporter::import ( )

import role | role templatae

Exceptions

ilRoleImporterException

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

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

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

Here is the call graph for this function:

◆ importSimpleXml()

ilRoleXmlImporter::importSimpleXml ( SimpleXMLElement $role )

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

References $id, $type, ilObject\_getIdsForTitle(), ilObject\_lookupType(), assignToRoleFolder(), ILIAS\Survey\Mode\getId(), getRole(), getRoleFolderId(), initRole(), ILIAS\Repository\int(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), ILIAS\Repository\logger(), and ILIAS\Repository\refinery().

Referenced by import().

                                                            : int
     {
         $import_id = (string) $role['id'];
         $this->logger->info('Importing role with import_id: ' . $import_id);
         $this->initRole($import_id);
 
         $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(
                     $this->language->txt("rbac_cant_import_role_wrong_type"),
                     $this->language->txt('obj_' . $exp[1]),
                     $this->language->txt('obj_' . $type)
                 ));
             }
 
             $exp[3] = $this->getRoleFolderId();
 
             $id = ilObjRole::_getIdsForTitle(implode("_", $exp));
 
             if ($id[0]) {
                 $this->getRole()->setId($id[0]);
                 $this->getRole()->read();
             }
         }
 
         // Create or update
         if ($this->getRole()->getId()) {
             $this->rbacadmin->deleteRolePermission($this->getRole()->getId(), $this->getRoleFolderId());
             $this->getRole()->update();
         } else {
             $this->getRole()->create();
         }
 
         $this->assignToRoleFolder();
 
         $protected = (string) $role['protected'];
         if ($protected) {
             $this->rbacadmin->setProtected(0, $this->getRole()->getId(), 'y');
         }
 
         // Add operations
         $ops = $this->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 && $ops_id) {
                     $this->rbacadmin->setRolePermission(
                         $this->getRole()->getId(),
                         $ops_group,
                         array($ops_id),
                         $this->getRoleFolderId() // #10161
                     );
                 }
             }
         }
         return $this->getRole()->getId();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initRole()

ilRoleXmlImporter::initRole ( string $import_id )

protected

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

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

Referenced by importSimpleXml().

                                                   : void
     {
         if ($this->getRole()) {
             return;
         }
 
         $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($import_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseXmlErrors()

ilRoleXmlImporter::parseXmlErrors ( )

protected

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

References $errors.

Referenced by import().

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

Here is the caller graph for this function:

◆ setRole()

ilRoleXmlImporter::setRole ( ilObject $role )

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

References $role.

                                            : void
     {
         $this->role = $role;
     }

◆ setXml()

ilRoleXmlImporter::setXml ( string $a_xml )

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

                                          : void
     {
         $this->xml = $a_xml;
     }

Field Documentation

◆ $language

ilLanguage ilRoleXmlImporter::$language

private

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

◆ $logger

ilLogger ilRoleXmlImporter::$logger

private

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

◆ $rbacadmin

ilRbacAdmin ilRoleXmlImporter::$rbacadmin

private

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

◆ $rbacreview

ilRbacReview ilRoleXmlImporter::$rbacreview

private

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

◆ $refinery

Refinery ilRoleXmlImporter::$refinery

private

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

◆ $role

ilObject ilRoleXmlImporter::$role = null

protected

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

Referenced by getRole(), and setRole().

◆ $role_folder

int ilRoleXmlImporter::$role_folder = 0

protected

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

Referenced by getRoleFolderId().

◆ $xml

string ilRoleXmlImporter::$xml = ''

protected

Definition at line 33 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

◆ $language

◆ $logger

◆ $rbacadmin

◆ $rbacreview

◆ $refinery

◆ $role

◆ $role_folder

◆ $xml