classes/class.ilObjectDefinition.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. |
        +-----------------------------------------------------------------------------+
*/


class ilObjectDefinition extends ilSaxParser
{
        var $obj_id;

        var $parent;

        var $obj_data;

        function ilObjectDefinition()
        {
                parent::ilSaxParser(ILIAS_ABSOLUTE_PATH."/objects.xml");
        }

// PUBLIC METHODS

        function getDefinition($a_obj_name)
        {
                return $this->obj_data[$a_obj_name];
        }

        function getClassName($a_obj_name)
        {
                return $this->obj_data[$a_obj_name]["class_name"];
        }


        function getLocation($a_obj_name)
        {
                return $this->obj_data[$a_obj_name]["location"];
        }


        function getModule($a_obj_name)
        {
                return $this->obj_data[$a_obj_name]["module"];
        }


        function hasCheckbox($a_obj_name)
        {
                return (bool) $this->obj_data[$a_obj_name]["checkbox"];
        }
        
        function getTranslationType($a_obj_name)
        {
                return $this->obj_data[$a_obj_name]["translate"];
        }

        function stopInheritance($a_obj_name)
        {
                return (bool) $this->obj_data[$a_obj_name]["inherit"];
        }

        function getProperties($a_obj_name)
        {
                // dirty hack, has to be implemented better, if ilias.php
                // is established
                if (defined("ILIAS_MODULE") || $_GET["baseClass"] != "")
                {
                        $props = array();
                        if (is_array($this->obj_data[$a_obj_name]["properties"]))
                        {
                                foreach ($this->obj_data[$a_obj_name]["properties"] as $data => $prop)
                                {
                                        if ($prop["module"] != "n")
                                        {
                                                $props[$data] = $prop;
                                        }
                                }
                        }
                        return $props;
                }
                else
                {
                        $props = array();
                        if (is_array($this->obj_data[$a_obj_name]["properties"]))
                        {
                                foreach ($this->obj_data[$a_obj_name]["properties"] as $data => $prop)
                                {
                                        if ($prop["module"] != 1)
                                        {
                                                $props[$data] = $prop;
                                        }
                                }
                        }
                        return $props;
                }
        }

        function getDevMode($a_obj_name)
        {
                // always return false if devmode is enabled
                if (DEVMODE)
                {
                        return false;
                }
                
                return (bool) $this->obj_data[$a_obj_name]["devmode"];
        }

        function getDevModeAll()
        {
                // always return empty array if devmode is enabled
                if (DEVMODE)
                {
                        return array();
                }

                $types = array_keys($this->obj_data);
                
                foreach ($types as $type)
                {
                        if ($this->getDevMode($type))
                        {
                                $devtypes[] = $type;
                        }
                }

                return $devtypes ? $devtypes : array();
        }

        function isRBACObject($a_obj_name)
        {
                return (bool) $this->obj_data[$a_obj_name]["rbac"];
        }

        function getAllRBACObjects()
        {
                $types = array_keys($this->obj_data);
                
                foreach ($types as $type)
                {
                        if ($this->isRBACObject($type))
                        {
                                $rbactypes[] = $type;
                        }
                }

                return $rbactypes ? $rbactypes : array();
        }

        function allowLink($a_obj_name)
        {
                return (bool) $this->obj_data[$a_obj_name]["allow_link"];
        }

        function getSubObjects($a_obj_type,$a_filter = true)
        {
                $subs = array();

                if ($subobjects = $this->obj_data[$a_obj_type]["subobjects"])
                {
                        // Filter some objects e.g chat object are creatable if chat is active
                        if ($a_filter)
                        {
                                $this->__filterObjects($subobjects);
                        }

                        foreach ($subobjects as $data => $sub)
                        {
                                if ($sub["module"] != "n")
                                {
                                        $subs[$data] = $sub;
                                }
                        }

                        return $subs;
                }

                return $subs;
        }

        function getSubObjectsRecursively($a_obj_type)
        {
                // This associative array is used to collect all subobject types.
                // key=>type, value=data
                $recursivesubs = array();

                // This array is used to keep track of the object types, we
                // need to call function getSubobjects() for.
                $to_do = array($a_obj_type);

                // This array is used to keep track of the object types, we
                // have called function getSubobjects() already. This is to
                // prevent endless loops, for object types that support 
                // themselves as subobject types either directly or indirectly.
                $done = array();

                while (count($to_do) > 0)
                {
                        $type = array_pop($to_do);
                        $done[] = $type;
                        $subs = $this->getSubObjects($type);
                        foreach ($subs as $subtype => $data)
                        {
                                $recursivesubs[$subtype] = $data;
                                if (! in_array($subtype, $done)
                                && ! in_array($subtype, $to_do))
                                {
                                        $to_do[] = $subtype;
                                }
                        }
                }

                return $recursivesubs;
        }

        function getSubobjectsToFilter($a_obj_type = "adm")
        {
                foreach($this->obj_data[$a_obj_type]["subobjects"] as $key => $value)
                {
                        switch($key)
                        {
                                case "rolf":
                                        // DO NOTHING
                                        break;

                                default:
                                        $tmp_subs[] = $key;
                        }
                }
                // ADD adm and root object
                $tmp_subs[] = "adm";
                $tmp_subs[] = "root";

                return $tmp_subs ? $tmp_subs : array();
        }
                
        function getCreatableSubObjects($a_obj_type)
        {
                $subobjects = $this->getSubObjects($a_obj_type);

                // remove role folder object from list 
                unset($subobjects["rolf"]);
                
                $sub_types = array_keys($subobjects);

                // remove object types in development from list
                foreach ($sub_types as $type)
                {
                        if ($this->getDevMode($type))
                        {
                                unset($subobjects[$type]);
                        }
                }

                return $subobjects;
        }

        function getActions($a_obj_name)
        {
                $ret = (is_array($this->obj_data[$a_obj_name]["actions"])) ?
                        $this->obj_data[$a_obj_name]["actions"] :
                        array();
                return $ret;
        }

        function getFirstProperty($a_obj_name)
        {
                if (defined("ILIAS_MODULE"))
                {
                        foreach ($this->obj_data[$a_obj_name]["properties"] as $data => $prop)
                        {
                                if($prop["module"] != "n")
                                {
                                        return $data;
                                }
                        }
                }
                else
                {
                        foreach ($this->obj_data[$a_obj_name]["properties"] as $data => $prop)
                        {
                                if ($prop["module"] != 1)
                                {
                                        return $data;
                                }
                        }
                }
        }

        function getPropertyName($a_cmd, $a_obj_name)
        {
                return $this->obj_data[$a_obj_name]["properties"][$a_cmd]["lng"];
        }

        function getSubObjectsAsString($a_obj_type)
        {
                $string = "";

                if (is_array($this->obj_data[$a_obj_type]["subobjects"]))
                {
                        $data = array_keys($this->obj_data[$a_obj_type]["subobjects"]);

                        $string = "'".implode("','", $data)."'";
                }
                
                return $string;
        }

        function getImportObjects($a_obj_type)
        {
                $imp = array();

                if (is_array($this->obj_data[$a_obj_type]["subobjects"]))
                {
                        foreach ($this->obj_data[$a_obj_type]["subobjects"] as $sub)
                        {
                                if ($sub["import"] == 1)
                                {
                                        $imp[] = $sub["name"];
                                }
                        }
                }

                return $imp;
        }

// PRIVATE METHODS

        function setHandlers($a_xml_parser)
        {
                xml_set_object($a_xml_parser,$this);
                xml_set_element_handler($a_xml_parser,'handlerBeginTag','handlerEndTag');
                xml_set_character_data_handler($a_xml_parser,'handlerCharacterData');
        }

        function handlerBeginTag($a_xml_parser,$a_name,$a_attribs)
        {
                switch ($a_name)
                {
                        case 'objects':
                                $this->current_tag = '';
                                break;
                        case 'object':
                                $this->parent_tag_name = $a_attribs["name"];
                                $this->current_tag = '';
                                $this->obj_data["$a_attribs[name]"]["name"] = $a_attribs["name"];
                                $this->obj_data["$a_attribs[name]"]["class_name"] = $a_attribs["class_name"];
                                $this->obj_data["$a_attribs[name]"]["location"] = $a_attribs["location"];
                                $this->obj_data["$a_attribs[name]"]["checkbox"] = $a_attribs["checkbox"];
                                $this->obj_data["$a_attribs[name]"]["inherit"] = $a_attribs["inherit"];
                                $this->obj_data["$a_attribs[name]"]["module"] = $a_attribs["module"];
                                $this->obj_data["$a_attribs[name]"]["translate"] = $a_attribs["translate"];
                                $this->obj_data["$a_attribs[name]"]["devmode"] = $a_attribs["devmode"];
                                $this->obj_data["$a_attribs[name]"]["allow_link"] = $a_attribs["allow_link"];
                                $this->obj_data["$a_attribs[name]"]["rbac"] = $a_attribs["rbac"];
                                break;
                        case 'subobj':
                                $this->current_tag = "subobj";
                                $this->current_tag_name = $a_attribs["name"];
                                $this->obj_data[$this->parent_tag_name]["subobjects"][$this->current_tag_name]["name"] = $a_attribs["name"];
                                // NUMBER OF ALLOWED SUBOBJECTS (NULL means no limit)
                                $this->obj_data[$this->parent_tag_name]["subobjects"][$this->current_tag_name]["max"] = $a_attribs["max"];
                                // also allow import ("1" means yes)
                                $this->obj_data[$this->parent_tag_name]["subobjects"][$this->current_tag_name]["import"] = $a_attribs["import"];
                                $this->obj_data[$this->parent_tag_name]["subobjects"][$this->current_tag_name]["module"] = $a_attribs["module"];
                                break;
                        case 'property':
                                $this->current_tag = "property";
                                $this->current_tag_name = $a_attribs["name"];
                                $this->obj_data[$this->parent_tag_name]["properties"][$this->current_tag_name]["name"] = $a_attribs["name"];
                                $this->obj_data[$this->parent_tag_name]["properties"][$this->current_tag_name]["module"] = $a_attribs["module"];
                                break;
                        case 'action':
                                $this->current_tag = "action";
                                $this->current_tag_name = $a_attribs["name"];
                                $this->obj_data[$this->parent_tag_name]["actions"][$this->current_tag_name]["name"] = $a_attribs["name"];
                                break;
                }
        }

        function handlerCharacterData($a_xml_parser,$a_data)
        {
                // DELETE WHITESPACES AND NEWLINES OF CHARACTER DATA
                $a_data = preg_replace("/\n/","",$a_data);
                $a_data = preg_replace("/\t+/","",$a_data);

                if (!empty($a_data))
                {
                        switch ($this->current_tag)
                        {
                                case "subobj":
                                        $this->obj_data[$this->parent_tag_name]["subobjects"][$this->current_tag_name]["lng"] .= $a_data;
                                        break;
                                case "action" :
                                        $this->obj_data[$this->parent_tag_name]["actions"][$this->current_tag_name]["lng"] .= $a_data;
                                        break;
                                case "property" :
                                        $this->obj_data[$this->parent_tag_name]["properties"][$this->current_tag_name]["lng"] .= $a_data;
                                        break;
                                default:
                                        break;
                        }
                }
        }

        function handlerEndTag($a_xml_parser,$a_name)
        {
                $this->current_tag = '';
                $this->current_tag_name = '';
        }

        function __filterObjects(&$subobjects)
        {
                foreach($subobjects as $type => $data)
                {
                        switch($type)
                        {
                                case "chat":
                                        if(!$this->ilias->getSetting("chat_active"))
                                        {
                                                unset($subobjects[$type]);
                                        }
                                        break;

                                case "icrs":
                                        if(!$this->ilias->getSetting("ilinc_active"))
                                        {
                                                unset($subobjects[$type]);
                                        }
                                        break;                                  

                                default:
                                        // DO NOTHING
                        }
                }
        }
}
?>