class.ilObjectXMLWriter.php

Go to the documentation of this file.

<?php

/*
    +-----------------------------------------------------------------------------+
    | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
    | Copyright (c) 1998-2001 ILIAS open source, University of Cologne            |
    |                                                                             |
    | This program is free software; you can redistribute it and/or               |
    | modify it under the terms of the GNU General Public License                 |
    | as published by the Free Software Foundation; either version 2              |
    | of the License, or (at your option) any later version.                      |
    |                                                                             |
    | This program is distributed in the hope that it will be useful,             |
    | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
    | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
    | GNU General Public License for more details.                                |
    |                                                                             |
    | You should have received a copy of the GNU General Public License           |
    | along with this program; if not, write to the Free Software                 |
    | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
    +-----------------------------------------------------------------------------+
*/

include_once "./classes/class.ilXmlWriter.php";

class ilObjectXMLWriter extends ilXmlWriter
{
        var $ilias;

        var $xml;
        var $enable_operations = false;
        var $objects = array();
        var $user_id = 0;

        function ilObjectXMLWriter()
        {
                global $ilias,$ilUser;

                parent::ilXmlWriter();

                $this->ilias =& $ilias;
                $this->user_id = $ilUser->getId();
        }

        function setUserId($a_id)
        {
                $this->user_id = $a_id;
        }
        function getUserId()
        {
                return $this->user_id;
        }

        function enableOperations($a_status)
        {
                $this->enable_operations = $a_status;

                return true;
        }

        function enabledOperations()
        {
                return $this->enable_operations;
        }

        function setObjects($objects)
        {
                $this->objects = $objects;
        }

        function __getObjects()
        {
                return $this->objects ? $this->objects : array();
        }

        function start()
        {
                /*if(!count($objects = $this->__getObjects()))
                {
                        return false;
                }*/

                $this->__buildHeader();

                foreach($this->__getObjects() as $object)
                {
                        $this->__appendObject($object);
                }
                $this->__buildFooter();

                return true;
        }

        function getXML()
        {
                return $this->xmlDumpMem(FALSE);
        }


        // PRIVATE
        function __appendObject(&$object)
        {

          global $tree, $rbacreview;

                $id = $object->getId();
                if ($object->getType() == "role" && $rbacreview->isRoleDeleted($id))
                {
                        return;                         
                }                       
          
                $attrs = array('type' => $object->getType(),
                               'obj_id' => $id);

                $this->xmlStartTag('Object',$attrs);
                $this->xmlElement('Title',null,$object->getTitle());
                $this->xmlElement('Description',null,$object->getDescription());
                $this->xmlElement('Owner',null,$object->getOwner());
                $this->xmlElement('CreateDate',null,$object->getCreateDate());
                $this->xmlElement('LastUpdate',null,$object->getLastUpdateDate());
                $this->xmlElement('ImportId',null,$object->getImportId());

                foreach(ilObject::_getAllReferences($object->getId()) as $ref_id)
                {
                        if (!$tree->isInTree($ref_id))
                                continue;
                        
                        $attr = array('ref_id' => $ref_id, 'parent_id'=> $tree->getParentId(intval($ref_id)));
                        $attr['accessInfo'] = $this->__getAccessInfo($object,$ref_id);                  
                        $this->xmlStartTag('References',$attr);
                        $this->__appendOperations($ref_id,$object->getType());
                        $this->__appendPath ($ref_id);
                        $this->xmlEndTag('References');
                }
                $this->xmlEndTag('Object');
        }

        function __appendOperations($a_ref_id,$a_type)
        {
                global $ilAccess,$rbacreview;

                if($this->enabledOperations())
                {
                    $ops = $rbacreview->getOperationsOnTypeString($a_type);
                    if (is_array($ops))
                    {
                        foreach($ops as $ops_id)
                        {
                                $operation = $rbacreview->getOperation($ops_id);
                                        
                                if(count ($operation) && $ilAccess->checkAccessOfUser($this->getUserId(),$operation['operation'],'view',$a_ref_id))
                                {
                                        $this->xmlElement('Operation',null,$operation['operation']);
                                }
                        }
                    }
                }
                return true;
        }


        function __appendPath ($refid){
                ilObjectXMLWriter::appendPathToObject($this, $refid);
        }
        
        function __buildHeader()
        {
                $this->xmlSetDtdDef("<!DOCTYPE Objects PUBLIC \"-//ILIAS//DTD ILIAS Repositoryobjects//EN\" \"".ILIAS_HTTP_PATH."/xml/ilias_object_3_10.dtd\">");
                $this->xmlSetGenCmt("Export of ILIAS objects");
                $this->xmlHeader();
                $this->xmlStartTag("Objects");
                return true;
        }

        function __buildFooter()
        {
                $this->xmlEndTag('Objects');
        }

        function __getAccessInfo(&$object,$ref_id)
        {
                global $ilAccess;

                include_once 'Services/AccessControl/classes/class.ilAccessHandler.php';

                $ilAccess->checkAccessOfUser($this->getUserId(),'read','view',$ref_id,$object->getType(),$object->getId());

                if(!$info = $ilAccess->getInfo())
                {
                        return 'granted';
                }
                else
                {
                        return $info[0]['type'];
                }
        }

        
        public static function appendPathToObject ($writer, $refid){
                global $tree, $lng;
                $items = $tree->getPathFull($refid);
                $writer->xmlStartTag("Path");
                foreach ($items as $item) {
                        if ($item["ref_id"] == $refid)
                                continue;
                        if ($item["type"] == "root")
                        {
                                $item["title"] = $lng->txt("repository");
                        }                       
                        $writer->xmlElement("Element", array("ref_id" => $item["ref_id"], "type" => $item["type"]), $item["title"]);
                }               
                $writer->xmlEndTag("Path");                                             
        }
        
}


?>