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

Source for file DBConfig.php

Documentation is available at DBConfig.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.  * @copyright  2004-2007 The ZNF Development Team
  16.  * @license    LGPL License 2.1 <http://www.gnu.org/copyleft/lesser.html>
  17.  * @version    SVN $Id: DBConfig.php 43 2007-06-26 23:36:35Z aronnax $
  18.  * @since      Release 0.7.5
  19.  * @link       http://www.zeronotice.org
  20.  */
  21.  
  22. /**
  23.  * <i>ZNF_Config_DBConfig</i> contains the collection of static database configuration informations.
  24.  *
  25.  * Returns the <i>ZNF_Config_DBConfig</i> object reference with a singleton
  26.  * pattern.
  27.  *
  28.  * @access     public
  29.  * @package    ZNF
  30.  * @subpackage Config
  31.  * @author     Alessandro Rossini <http://www.alessandrorossini.org>
  32.  * @author     Graziano Liberati <http://www.liberati.org>
  33.  * @copyright  2004-2007 The ZNF Development Team
  34.  * @license    LGPL License 2.1 <http://www.gnu.org/copyleft/lesser.html>
  35.  * @version    SVN $Id: DBConfig.php 43 2007-06-26 23:36:35Z aronnax $
  36.  * @since      Release 0.7.5
  37.  * @link       http://www.zeronotice.org
  38.  */
  39. class ZNF_Config_DBConfig
  40. {
  41.  
  42.     /**
  43.      * Name of the configuration file.
  44.      */
  45.     const CONFIG_FILE = 'znf-db-config.xml';
  46.  
  47.     /**
  48.      * The <i>ZNF_Config_DBConfig</i> object reference.
  49.      *
  50.      * @access protected
  51.      * @staticvar ZNF_Config_DBConfig $_dbConfig 
  52.      */
  53.     static protected $_dbConfig;
  54.  
  55.     /**
  56.      * The array of the configuration file.
  57.      *
  58.      * @access protected
  59.      * @var array $_config 
  60.      */
  61.     protected $_config;
  62.  
  63.     /**
  64.      * Private constructor to avoid <i>ZNF_Config_DBConfig</i> object creation.
  65.      *
  66.      * @access private
  67.      */
  68.     private function __construct()
  69.     {
  70.         $this->_parseConfiguration();
  71.     }
  72.  
  73.     /**
  74.      * Private clonator to avoid <i>ZNF_Config_DBConfig</i> object clonation.
  75.      *
  76.      * @access private
  77.      */
  78.     private function __clone()
  79.     {
  80.     }
  81.  
  82.     /**
  83.      * Returns the reference to the <i>ZNF_Config_DBConfig</i> object with a singleton pattern.
  84.      *
  85.      * This object is shared by all the classes that require the database
  86.      * configuration.
  87.      *
  88.      * @static
  89.      * @access public
  90.      * @return ZNF_Config_DBConfig 
  91.      */
  92.     static public function getInstance()
  93.     {
  94.         if (!(isset(self::$_dbConfig))) {
  95.             self::$_dbConfig = new ZNF_Config_DBConfig();
  96.         }
  97.  
  98.         return self::$_dbConfig;
  99.     }
  100.  
  101.     /**
  102.      * Parses and validates the configuration file.
  103.      *
  104.      * For performance reasons implements a caching mechanism that serializes the
  105.      * configuration file in an internal structure.
  106.      *
  107.      * @access protected
  108.      */
  109.     protected function _parseConfiguration()
  110.     {
  111.         $xmlTimestamp = filemtime(ZNF::CONFIG_DIR . '/' . self::CONFIG_FILE);
  112.         $serializedTimestamp = @filemtime(ZNF::CACHE_DIR . '/' . self::CONFIG_FILE . '.cache');
  113.  
  114.         if ($xmlTimestamp <= $serializedTimestamp) {
  115.             $this->_config = unserialize(file_get_contents(ZNF::CACHE_DIR . '/' . self::CONFIG_FILE . '.cache'));
  116.         } else {
  117.             $configXml = new DOMDocument('1.0','utf-8');
  118.             $configXml->load(ZNF::CONFIG_DIR . '/' . self::CONFIG_FILE);
  119.  
  120.             // quick hack to make ZNF work as a PEAR package, to be improved
  121.             $dirName = dirname(__FILE__);
  122.             $schemaPath = substr($dirName, 0, strpos($dirName, 'Config')) . "xsd/znf-db-config.xsd";
  123.             if (!$configXml->schemaValidate($schemaPath)) {
  124.                 $translation = new ZNF_Presentation_Translation('ZNF', $_SESSION['znf']['lang']);
  125.                 throw new ZNF_Config_DBConfigException($translation->get('errorDbCfgFileNotValid'));
  126.             }
  127.  
  128.             $xpath = new DOMXPath($configXml);
  129.             $xpath->registerNamespace('db', 'http://www.zeronotice.org/ZNF/znf-db-config');
  130.             $config = array();
  131.             $default = $xpath->query('/db:znf-db-config/db:db[@default="true"]');
  132.  
  133.             if ($default->length == 1) {
  134.                 $config['db']['dbms']     = $default->item(0)->getAttribute('dbms');
  135.                 $config['db']['username'] = $default->item(0)->getAttribute('username');
  136.                 $config['db']['password'] = $default->item(0)->getAttribute('password');
  137.                 $config['db']['hostname'] = $default->item(0)->getAttribute('hostname');
  138.                 $config['db']['dbname']   = $default->item(0)->getAttribute('dbname');
  139.                 $config['db']['tableprefix']   = $default->item(0)->getAttribute('tableprefix');
  140.             // check if only one default action is specified
  141.             } elseif ($default->length > 1) {
  142.                 $translation = new ZNF_Presentation_Translation('ZNF', $_SESSION['znf']['lang']);
  143.                 throw new ZNF_Config_DBConfigException($translation->get('errorDbCfgOneDbDefault'));
  144.             // check if at least one default action is specified
  145.             } else {
  146.                 $translation = new ZNF_Presentation_Translation('ZNF', $_SESSION['znf']['lang']);
  147.                 throw new ZNF_Config_DBConfigException($translation->get('errorDbCfgAtLeastOneDbDefault'));
  148.             }
  149.  
  150.             file_put_contents(ZNF::CACHE_DIR . '/' . self::CONFIG_FILE . '.cache', serialize($config));
  151.             $this->_config = $config;
  152.         }
  153.     }
  154.  
  155.     /**
  156.      * Returns the database DBMS.
  157.      *
  158.      * @access public
  159.      * @return string 
  160.      */
  161.     public function getDbms()
  162.     {
  163.         return $this->_config['db']['dbms'];
  164.     }
  165.  
  166.     /**
  167.      * Returns the database username.
  168.      *
  169.      * @access public
  170.      * @return string 
  171.      */
  172.     public function getUsername()
  173.     {
  174.         return $this->_config['db']['username'];
  175.     }
  176.  
  177.     /**
  178.      * Returns the database password.
  179.      *
  180.      * @access public
  181.      * @return string 
  182.      */
  183.     public function getPassword()
  184.     {
  185.         return $this->_config['db']['password'];
  186.     }
  187.  
  188.     /**
  189.      * Returns the database hostname.
  190.      *
  191.      * @access public
  192.      * @return string 
  193.      */
  194.     public function getHostname()
  195.     {
  196.         return $this->_config['db']['hostname'];
  197.     }
  198.  
  199.     /**
  200.      * Returns the database dbname.
  201.      *
  202.      * @access public
  203.      * @return string 
  204.      */
  205.     public function getDbname()
  206.     {
  207.         return $this->_config['db']['dbname'];
  208.     }
  209.  
  210.     /**
  211.      * Returns the database table prefix.
  212.      *
  213.      * @access public
  214.      * @return string 
  215.      */
  216.     public function getTablePrefix()
  217.     {
  218.         return $this->_config['db']['tableprefix'];
  219.     }
  220.  
  221.     /**
  222.      * Destroys the <i>ZNF_Config_DBConfig</i> object.
  223.      *
  224.      * @access public
  225.      */
  226.     public function __destruct()
  227.     {
  228.     }
  229.  
  230. }
  231.  
  232. /**
  233.  * <i>ZNF_Config_DBConfigException</i> is the exception type for the <i>ZNF_Config_DBConfig</i> class.
  234.  *
  235.  * <i>ZNF_Config_DBConfigException</i> extends the <i>Exception</i> class of PHP5.
  236.  *
  237.  * @access     public
  238.  * @package    ZNF
  239.  * @subpackage Config
  240.  * @author     Alessandro Rossini <http://www.alessandrorossini.org>
  241.  * @author     Graziano Liberati <http://www.liberati.org>
  242.  * @copyright  2004-2007 The ZNF Development Team
  243.  * @license    LGPL License 2.1 <http://www.gnu.org/copyleft/lesser.html>
  244.  * @version    SVN $Id: DBConfig.php 43 2007-06-26 23:36:35Z aronnax $
  245.  * @since      Release 0.7.5
  246.  * @link       http://www.zeronotice.org
  247.  */
  248. class ZNF_Config_DBConfigException extends Exception
  249. {
  250. }
  251.  
  252. ?>
Documentation generated on Wed, 14 Nov 2007 23:47:36 +0100 by phpDocumentor 1.4.0