ModuleInfoXml.class.php

Go to the documentation of this file.

<?php
include_once("core/utils/XmlParser.class.php");
include_once("core/modules/moduleinformation/IModuleInfo.class.php");
include_once("core/modules/moduleinformation/backends/ModuleInfoXmlPermission.class.php");
include_once("core/modules/moduleinformation/backends/ModuleInfoXmlConfig.class.php");

define("ERROR_OPEN", 1);
define("ERROR_NO_NAME", 2);
define("ERROR_NOT_VALID", 3);

class ModuleInfoXml extends IModuleInfo
{
        var $filename;          
        
        var $parser;            
        
        var $name;                      
        var $version;           
        var $screenname;        
        var $permissions;       
        var $config;            
        var $what_implements;   
        var $what_requires;             
        var $sql;                       
        
        function ModuleInfoXml($name)
        {
                $this->filename = $name;

                $this->parser = new XmlParser($this->filename);
                
                $error = $this->_ProcessXml();
                
                if (JSystem::IsError($error))
                        $this->RaiseConstructorError($error);           
        }
        
        function _ProcessXml()
        {
                $tree =& $this->parser->getTree();
                
                // Getting attributes
                $this->name = $tree["attributes"]["name"];
                if (! $this->name)
                        return $this->RaiseError(ERROR_NO_NAME, "The module has no name");
                $this->version = $tree["attributes"]["version"];
                
                // Processing the children
                $this->_ProcessXmlChildren($tree["children"]);
        }
        
        function _ProcessXmlChildren($tree)
        {
                foreach ($tree as $childtree)
                {
                        switch($childtree["tag"])
                        {
                                case "screenname":
                                        $lang = $childtree["attributes"]["lang"];
                                        if (!$childtree["attributes"]["lang"])
                                                $lang = "default";
                                        $this->screenname[$lang] = $childtree["value"];
                                        break;
                                        
                                case "permissions":
                                        $this->_ProcessXmlPermissions($childtree);
                                        break;
                                
                                case "config":
                                        $this->_ProcessXmlConfig($children);
                                        break;
                                        
                                case "implements":
                                        $this->what_implements[] = $childtree["value"];
                                        break;
                                
                                case "requires":
                                        $this->what_requires[] = $childtree["value"];
                                        break;
                                        
                                case "sql":
                                        $this->sql[] = $childtree["value"];
                                        break;
                        }
                }
        }
        
        function _ProcessXmlPermissions($tree)
        {
                if(count($tree["children"]) > 0)
                {
                        foreach($tree["children"] as $perm)
                        {
                                $mixperm = new ModuleInfoXmlPermission($perm);
                                $this->permissions[$mixperm->getName()] = $mixperm;
                        }
                }
        }
        
        function _ProcessXmlConfig($tree)
        {
                if (count($tree["children"]) > 0)
                {
                        foreach($tree["children"] as $conf)
                        {
                                $mixconf = new ModuleInfoXmlConfig($conf);
                                $this->config[$mixconf->getName()] = $mixconf;
                        }
                }
        }
        
        function getName()
        {
                return $this->name;
        }
        
        function getVersion()
        {
                return $this->version;
        }
        
        function getScreenNames()
        {
                return $this->screenname;
        } 
        
        function getPermissions()
        {
                return $this->permissions;
        }
        
        function getConfig()
        {
                return $this->config;
        }
        
        function getImplements()
        {
                return $this->what_implements;
        }
        
        function Implements($string)
        {
                return in_array($string, $this->what_implements);
        }
        
        function getRequires()
        {
                return $this->what_requires;
        }
        
        function Requires($string)
        {
                return in_array($string, $this->what_requires);
        }
        
        function getSql()
        {
                return $this->sql;
        }
}
?>

---