class.ilRoleXmlExport.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

include_once './Services/Xml/classes/class.ilXmlWriter.php';

class ilRoleXmlExport extends ilXmlWriter
{
    const MODE_DTPL = 1;


    private $roles = array();
    private $operations = array();

    private $mode = 0;


    public function __construct()
    {
        parent::__construct();

        $this->initRbacOperations();
    }


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

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

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

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

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


    public function writeHeader()
    {
        $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();
        return true;
    }

    public function write()
    {
        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($a_role_id, $a_rolf)
    {
        global $rbacreview;
        
        $attributes = array(
            'type'      => ilObject::_lookupType($a_role_id),
            'id'        => 'il_' . IL_INST_ID . '_' . ilObject::_lookupType($a_role_id) . '_' . $a_role_id,
            'protected' => ($GLOBALS['rbacreview']->isProtected($a_rolf, $a_role_id) ? 1 : 0)
        );

        $this->xmlStartTag('role', $attributes);

        $this->xmlElement('title', array(), ilObject::_lookupTitle($a_role_id));
        $this->xmlElement('description', array(), ilObject::_lookupDescription($a_role_id));

        $this->xmlStartTag('operations');
        foreach ($rbacreview->getAllOperationsOfRole($a_role_id, $a_rolf) as $obj_group => $operations) {
            foreach ($operations as $ops_id) {
                $this->xmlElement('operation', array('group' => $obj_group), trim($this->operations[$ops_id]));
            }
        }
        $this->xmlEndTag('operations');
        $this->xmlEndTag('role');
        return true;
    }

    private function initRbacOperations()
    {
        global $rbacreview;

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