phpDocumentor ZNF
Config
[ class tree: ZNF ] [ index: ZNF ] [ all elements ]
ZNF
Packages:
ZNF

Source for file AppConfig.php

Documentation is available at AppConfig.php

  1. <?php
  2. /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
  3. /**
  4.  * PHP version 5
  5.  *
  6.  * This source file is subject to version 2.1 of the GNU Lesser General Public
  7.  * License, that is bundled with this package in the file COPYING, available
  8.  * through the world wide web at the following URI:
  9.  * http://www.gnu.org/copyleft/lesser.html.
  10.  *
  11.  * @package    ZNF
  12.  * @subpackage Config
  13.  * @author     Alessandro Rossini <http://www.alessandrorossini.org>
  14.  * @author     Graziano Liberati <http://www.liberati.org>
  15.  * @author     Tomasz Kuter <evolic@interia.pl>
  16.  * @copyright  2004-2007 The ZNF Development Team
  17.  * @license    LGPL License 2.1 <http://www.gnu.org/copyleft/lesser.html>
  18.  * @version    SVN $Id: AppConfig.php 44 2007-07-22 23:55:30Z evolic $
  19.  * @since      Release 0.7.5
  20.  * @link       http://www.zeronotice.org
  21.  */
  22.  
  23. /**
  24.  * <i>ZNF_Config_AppConfig</i> contains the collection of static application configuration informations.
  25.  *
  26.  * Returns the <i>ZNF_Config_AppConfig</i> object reference with a singleton
  27.  * pattern.
  28.  *
  29.  * @access     public
  30.  * @package    ZNF
  31.  * @subpackage Config
  32.  * @author     Alessandro Rossini <http://www.alessandrorossini.org>
  33.  * @author     Graziano Liberati <http://www.liberati.org>
  34.  * @author     Tomasz Kuter <evolic@interia.pl>
  35.  * @copyright  2004-2007 The ZNF Development Team
  36.  * @license    LGPL License 2.1 <http://www.gnu.org/copyleft/lesser.html>
  37.  * @version    SVN $Id: AppConfig.php 44 2007-07-22 23:55:30Z evolic $
  38.  * @since      Release 0.7.5
  39.  * @link       http://www.zeronotice.org
  40.  */
  41. class ZNF_Config_AppConfig
  42. {
  43.  
  44.     /**
  45.      * Name of the configuration file.
  46.      */
  47.     const CONFIG_FILE = 'znf-app-config.xml';
  48.  
  49.     /**
  50.      * The <i>ZNF_Config_AppConfig</i> object reference.
  51.      *
  52.      * @access protected
  53.      * @staticvar ZNF_Config_AppConfig $_appConfig 
  54.      */
  55.     static protected $_appConfig;
  56.  
  57.     /**
  58.      * The array of the configuration file.
  59.      *
  60.      * @access protected
  61.      * @var array $_config 
  62.      */
  63.     protected $_config;
  64.  
  65.     /**
  66.      * Private constructor to avoid <i>ZNF_Config_AppConfig</i> object creation.
  67.      *
  68.      * @access private
  69.      */
  70.     private function __construct()
  71.     {
  72.         $this->_parseConfiguration();
  73.     }
  74.  
  75.     /**
  76.      * Private clonator to avoid <i>ZNF_Config_AppConfig</i> object clonation.
  77.      *
  78.      * @access private
  79.      */
  80.     private function __clone()
  81.     {
  82.     }
  83.  
  84.     /**
  85.      * Returns the reference to the <i>ZNF_Config_AppConfig</i> object with a singleton pattern.
  86.      *
  87.      * This object is shared by all the classes that require the application
  88.      * configuration.
  89.      *
  90.      * @static
  91.      * @access public
  92.      * @return ZNF_Config_AppConfig 
  93.      */
  94.     static public function getInstance()
  95.     {
  96.         if (!(isset(self::$_appConfig))) {
  97.             self::$_appConfig = new ZNF_Config_AppConfig();
  98.         }
  99.  
  100.         return self::$_appConfig;
  101.     }
  102.  
  103.     /**
  104.      * Parses and validates the configuration file.
  105.      *
  106.      * For performance reasons implements a caching mechanism that serializes the
  107.      * configuration file in an internal structure.
  108.      *
  109.      * @access protected
  110.      */
  111.     protected function _parseConfiguration()
  112.     {
  113.         $xmlTimestamp = filemtime(ZNF::CONFIG_DIR . '/' . self::CONFIG_FILE);
  114.         $serializedTimestamp = @filemtime(ZNF::CACHE_DIR . ZNF::CACHE_DIR . '/' . self::CONFIG_FILE . '.cache');
  115.  
  116.         if ($xmlTimestamp <= $serializedTimestamp) {
  117.             $this->_config = unserialize(file_get_contents(ZNF::CACHE_DIR . '/' . self::CONFIG_FILE . '.cache'));
  118.         } else {
  119.             $configXml = new DOMDocument('1.0','utf-8');
  120.             $configXml->load(ZNF::CONFIG_DIR . '/' . self::CONFIG_FILE);
  121.  
  122.             if (!$configXml) {
  123.                 throw new ZNF_Config_AppConfigException('Error loading the application configuration file, file is not well formed');
  124.             }
  125.  
  126.             // quick hack to make ZNF work as a PEAR package, to be improved
  127.             $dirName = dirname(__FILE__);
  128.             $schemaPath = substr($dirName, 0, strpos($dirName, 'Config')) . "xsd/znf-app-config.xsd";
  129.             if (!$configXml->schemaValidate($schemaPath)) {
  130.                 throw new ZNF_Config_AppConfigException('Error loading the application configuration file, file is not valid');
  131.             }
  132.  
  133.             $xpath = new DOMXPath($configXml);
  134.             $xpath->registerNamespace('app', 'http://www.zeronotice.org/ZNF/znf-app-config');
  135.             $config = array();
  136.  
  137.             //get app settings
  138.             $appDefaults = $xpath->query('/app:znf-app-config/app:app-settings');
  139.             $config['app-settings']['theme']      = $appDefaults->item(0)->getAttribute('theme');
  140.  
  141.             if (!file_exists(ZNF::THEME_DIR . "/{$config['app-settings']['theme']}")) {
  142.                 throw new ZNF_Config_AppConfigException('Error loading the application configuration file, the selected theme is not present');
  143.             }
  144.  
  145.             $config['app-settings']['lang']       = $appDefaults->item(0)->getAttribute('lang');
  146.  
  147.             if (!file_exists(ZNF::THEME_DIR . "/{$config['app-settings']['theme']}/{$config['app-settings']['lang']}")) {
  148.                 throw new ZNF_Config_AppConfigException('Error loading the application configuration file, the selected language is not present');
  149.             }
  150.  
  151.             $config['app-settings']['locale']     = $appDefaults->item(0)->getAttribute('locale');
  152.             $config['app-settings']['langAutodetect'] = $appDefaults->item(0)->getAttribute('langAutodetect');
  153.             $config['app-settings']['sessionId']  = $appDefaults->item(0)->getAttribute('sessionId');
  154.  
  155.             // get default module
  156.             $default = $xpath->query('/app:znf-app-config/app:modules/app:module[@default="true"]');
  157.  
  158.             if ($default->length == 1) {
  159.                 $config['modules']['default']['name']      = $default->item(0)->getAttribute('name');
  160.                 $config['modules']['default']['config']    = $default->item(0)->getAttribute('config');
  161.                 $config['modules']['default']['processor'] = $default->item(0)->getAttribute('processor');
  162.  
  163.             // check if only one default module is defined
  164.             } elseif ($default->length > 1) {
  165.                 throw new ZNF_Config_ModulesConfigException('Error loading the module configuration file, only one module can be default');
  166.  
  167.             // check if at least one default module is defined
  168.             } else {
  169.                 throw new ZNF_Config_ModulesConfigException('Error loading the module configuration file, at least one module must be default');
  170.             }
  171.  
  172.             // get modules
  173.             $modules = $xpath->query('/app:znf-app-config/app:modules/app:module');
  174.  
  175.             foreach ($modules as $module) {
  176.                 $moduleName = $module->getAttribute('name');
  177.                 $config['modules'][$moduleName]['name']      = $moduleName;
  178.                 $config['modules'][$moduleName]['config']    = $module->getAttribute('config');
  179.                 $config['modules'][$moduleName]['processor'] = $module->getAttribute('processor');
  180.             }
  181.  
  182.             // get authentication configuration
  183.             $authConfig = $xpath->query('/app:znf-app-config/app:auth-config');
  184.  
  185.             if ($authConfig->length > 0) {
  186.                 $config['authConfig']['path'] = $authConfig->item(0)->getAttribute('path');
  187.             }
  188.  
  189.             // get wrong authorization configuration
  190.             $wrongAuthConfig = $xpath->query('/app:znf-app-config/app:wrong-auth-config');
  191.  
  192.             if ($wrongAuthConfig->length > 0) {
  193.                 $config['wrongAuthConfig']['path'] = $wrongAuthConfig->item(0)->getAttribute('path');
  194.             }
  195.  
  196.             file_put_contents(ZNF::CACHE_DIR . '/' . self::CONFIG_FILE . '.cache', serialize($config));
  197.             $this->_config = $config;
  198.         }
  199.     }
  200.  
  201.     /**
  202.      * Returns the application lang.
  203.      *
  204.      * @access public
  205.      * @return string 
  206.      */
  207.     public function getLang()
  208.     {
  209.         return $this->_config['app-settings']['lang'];
  210.     }
  211.  
  212.     /**
  213.      * Returns the application locale.
  214.      *
  215.      * @access public
  216.      * @return string 
  217.      */
  218.     public function getLocale()
  219.     {
  220.         return $this->_config['app-settings']['locale'];
  221.     }
  222.  
  223.     /**
  224.      * Returns the application autodetected language.
  225.      *
  226.      * @access public
  227.      * @return string 
  228.      */
  229.     public function getLangAutodetect()
  230.     {
  231.         return $this->_config['app-settings']['langAutodetect'];
  232.     }
  233.  
  234.     /**
  235.      * Returns the application session ID.
  236.      *
  237.      * @access public
  238.      * @return string 
  239.      */
  240.     public function getSessionId()
  241.     {
  242.         return $this->_config['app-settings']['sessionId'];
  243.     }
  244.  
  245.     /**
  246.      * Returns the application theme.
  247.      *
  248.      * @access public
  249.      * @return string 
  250.      */
  251.     public function getTheme()
  252.     {
  253.         return $this->_config['app-settings']['theme'];
  254.     }
  255.  
  256.     /**
  257.      * Returns the module for the defined <i>name</i>.
  258.      *
  259.      * @access public
  260.      * @param string $module 
  261.      * @return array 
  262.      */
  263.     public function findModule($module)
  264.     {
  265.         if ($module && array_key_exists($module, $this->_config['modules'])) {
  266.  
  267.             // extracts the configuration of the module requested
  268.             return $this->_config['modules'][$module];
  269.         } else {
  270.  
  271.             // extracts the configuration of the default module
  272.             return $this->_config['modules']['default'];
  273.         }
  274.     }
  275.  
  276.     /**
  277.      * Returns the authentication configuration.
  278.      *
  279.      * @access public
  280.      * @return array 
  281.      */
  282.     public function findAuthConfig()
  283.     {
  284.         if (isset($this->_config['authConfig'])) {
  285.  
  286.             // extracts the authentication configuration
  287.             return $this->_config['authConfig'];
  288.         }
  289.  
  290.         // authentication configuration not found
  291.         return null;
  292.     }
  293.  
  294.     /**
  295.      * Returns the wrong authentication configuration.
  296.      *
  297.      * @access public
  298.      * @return array 
  299.      */
  300.     public function findWrongAuthConfig()
  301.     {
  302.         if (isset($this->_config['wrongAuthConfig'])) {
  303.  
  304.             // extracts the authentication configuration
  305.             return $this->_config['wrongAuthConfig'];
  306.         }
  307.  
  308.         // authentication configuration not found
  309.         return null;
  310.     }
  311.  
  312.     /**
  313.      * Destroys the <i>ZNF_Config_AppConfig</i> object.
  314.      *
  315.      * @access public
  316.      */
  317.     public function __destruct()
  318.     {
  319.     }
  320.  
  321. }
  322.  
  323. /**
  324.  * <i>ZNF_Config_AppConfigException</i> is the exception type for the <i>ZNF_Config_AppConfig</i> class.
  325.  *
  326.  * <i>ZNF_Config_AppConfigException</i> extends the <i>Exception</i> class of PHP5.
  327.  *
  328.  * @access     public
  329.  * @package    ZNF
  330.  * @subpackage Config
  331.  * @author     Alessandro Rossini <http://www.alessandrorossini.org>
  332.  * @author     Graziano Liberati <http://www.liberati.org>
  333.  * @copyright  2004-2007 The ZNF Development Team
  334.  * @license    LGPL License 2.1 <http://www.gnu.org/copyleft/lesser.html>
  335.  * @version    SVN $Id: AppConfig.php 44 2007-07-22 23:55:30Z evolic $
  336.  * @since      Release 0.7.5
  337.  * @link       http://www.zeronotice.org
  338.  */
  339. class ZNF_Config_AppConfigException extends Exception
  340. {
  341. }
  342.  
  343. ?>
Documentation generated on Wed, 14 Nov 2007 23:47:35 +0100 by phpDocumentor 1.4.0