Modules.class.php

Go to the documentation of this file.

<?php
include_once("core/system/JBaseObject.class.php");
include_once("core/utils/JSession.class.php");
include_once("core/modules/Module.class.php");

/* Constants */
define(MODULES_SESSION_VAR, "james-modules");

class Modules extends JBaseObject
{
        var $modulesid;         

        var $modulesnames;      
        
        function Modules()
        {
                $this->_RefreshModules();
        }
        
        function &GetInstance()
        {
                static $ob;
                
                if (! isset($ob))
                {
                        // We look if it is in session
                        if (JSession::ExistsVar(MODULES_SESSION_VAR))
                        {
                                $ob = JSession::GetVar(MODULES_SESSION_VAR);
                        }
                        else
                        {
                                $ob = new Modules();
                                $ob->_UpdateSession();
                        }
                        
                        // Doing that thing, we make sure that 
                        // $ob->_UpdateSession will be called just before the
                        // scripts ends its execution, and the changes made in
                        // the object will be stored in session.
                        register_shutdown_function(array(&$ob, _UpdateSession));
                }
                return $ob;
        }
        
        function _UpdateSession()
        {
                JSession::SetVar(MODULES_SESSION_VAR, $this);
        }
        
        function _RefreshModules()
        {
                $modules = Module::GetAllModulesId();
                
                $this->modulesid = array();
                $this->modulesnames = array();
                
                while (! $modules->EOF)
                {
                        $idM = $modules->row["idM"];
                        $module =& new Module($idM);
                        $this->modulesid[$idM] =& $module;
                        $this->modulesnames[$module->GetName()] = $idM;
                        
                        $modules->Next();
                }
                
                $this->_UpdateSession();
        }
        
        function &GetAllModules()
        {
                return $this->modulesid;
        }

        function &GetModule($id, $refresh=false)
        {
                $module =& $this->_AccessModule($id, $refresh);
                        
                if (JSystem::IsError($module))
                {
                        // Try refreshing the info
                        $this->_RefreshModules();
                        $module =& $this->_AccessModule($id, $refresh);
                        
                        if (JSystem::IsError($module))
                        {
                                return JSystem::RaiseError(
                                                                new JSystemError(ERROR_MODULE_NOT_FOUND));
                        }
                        else
                                return $module;
                }
                else
                        return $module;
        }
        
        function &_AccessModule($id, $refresh=false)
        {
                // Check if the id is the idM of the module
                if (isset($this->modulesid[$id]))
                {
                        $idM = $id;
                }
                // Or if it is its name
                else if (isset($this->modulesnames[$id]))
                {
                        $idM = $this->modulesnames[$id];
                }
                else
                {
                        return JSystem::RaiseError(
                                        new JSystemError(ERROR_MODULE_NOT_FOUND));
                }
                        
                // If it was a valid module...                  
                if ($refresh)
                {
                        $module =& new Module($idM);
                        $this->modulesid[$idM] =& $module;
                        $this->modulesnames[$module->GetName()] = $idM;
                        $this->_UpdateSession();
                }
                        
                return $this->modulesid[$idM];
        }
        
        function &InstallModule($path)
        {
                include_once("core/modules/ModuleInstall.class.php");
                
                $minstall = new ModuleInstall($path);
                if (JSystem::IsError($minstall))
                {
                        $err = JSystem::GetLastError();
                        return $err;
                }

                $name = $minstall->Install();
                if (JSystem::IsError($name))
                {
                        return $name;
                }
                else
                {
                        $this->_RefreshModules();
                        $module =& $this->GetModule($name);
                }
                
                return $module;
        }
}
?>

---