class.ilRoleXmlExport.php

Go to the documentation of this file.

<?php

declare(strict_types=1);
class ilRoleXmlExport extends ilXmlWriter
{
    public const MODE_DTPL = 1;

    private array $roles = [];
    private array $operations = [];
    private int $mode = 0;

    protected ilRbacReview $rbacreview;

    public function __construct()
    {
        global $DIC;

        $this->rbacreview = $DIC->rbac()->review();

        parent::__construct();
        $this->initRbacOperations();
    }

    public function setRoles(array $a_roles): void
    {
        $this->roles = $a_roles;
    }

    public function getRoles(): array
    {
        return $this->roles;
    }

    public function addRole(int $a_role_id, int $a_rolf_id): void
    {
        $this->roles[$a_role_id][] = $a_rolf_id;
    }

    public function setMode(int $a_mode): void
    {
        $this->mode = $a_mode;
    }

    public function getMode(): int
    {
        return $this->mode;
    }

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

    public function write(): 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');
        }
    }

    private function writeRole(int $a_role_id, int $a_rolf): 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');
    }

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