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

Source for file PDO.php

Documentation is available at PDO.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 Business
  13.  * @author     Alessandro Rossini <http://www.alessandrorossini.org>
  14.  * @author     Graziano Liberati <http://www.liberati.org>
  15.  * @author     Markus Wigge <mwigge@marcant.net>
  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: DB.php 2 2005-10-20 15:54:16Z aronnax $
  19.  * @since      Release 0.7.7
  20.  * @link       http://www.zeronotice.org
  21.  */
  22.  
  23. require_once('ZNF/Config/DBConfig.php');
  24.  
  25. /**
  26.  * The <i>ZNF_Business_PDO</i> class uses the PHP Data Objects (PDO) extension.
  27.  *
  28.  * Connects to the database using the configuration taken from the database
  29.  * configuration file. Returns the <i>ZNF_Business_PDO</i> object reference with
  30.  * a singleton pattern.
  31.  *
  32.  * @access     public
  33.  * @package    ZNF
  34.  * @subpackage Business
  35.  * @author     Alessandro Rossini <http://www.alessandrorossini.org>
  36.  * @author     Graziano Liberati <http://www.liberati.org>
  37.  * @author     Markus Wigge <mwigge@marcant.net>
  38.  * @copyright  2004-2007 The ZNF Development Team
  39.  * @license    LGPL License 2.1 <http://www.gnu.org/copyleft/lesser.html>
  40.  * @version    SVN $Id: DB.php 2 2005-10-20 15:54:16Z aronnax $
  41.  * @since      Release 0.7.7
  42.  * @link       http://www.zeronotice.org
  43.  */
  44. class ZNF_Business_PDO
  45. {
  46.  
  47.     /**
  48.      * The database object reference.
  49.      *
  50.      * @access private
  51.      * @staticvar ZNF_Business_PDO $_db 
  52.      */
  53.     static private $_db;
  54.  
  55.     /**
  56.      * Prefix used in the name of the database tables.
  57.      *
  58.      * @access private
  59.      * @staticvar string $_tablePrefix 
  60.      */
  61.     static private $_tablePrefix;
  62.  
  63.     /**
  64.      * Private constructor to avoid <i>ZNF_Business_PDO</i> object creation.
  65.      *
  66.      * @access private
  67.      */
  68.     private function __construct()
  69.     {
  70.     }
  71.  
  72.     /**
  73.      * Private clonator to avoid <i>ZNF_Business_PDO</i> object clonation.
  74.      *
  75.      * @access private
  76.      */
  77.     private function __clone()
  78.     {
  79.     }
  80.  
  81.     /**
  82.      * Returns the reference to the <i>ZNF_Business_PDO</i> object with a singleton pattern.
  83.      *
  84.      * This object is shared by all the classes that require the access to the
  85.      * database.
  86.      *
  87.      * @static
  88.      * @access public
  89.      * @return ZNF_Business_PDO 
  90.      */
  91.     static public function getInstance()
  92.     {
  93.         if (!(isset(self::$_db))) {
  94.             $dbConfig = ZNF_Config_DBConfig::getInstance();
  95.             $dsn = "{$dbConfig->getDbms()}:host={$dbConfig->getHostname()};dbname={$dbConfig->getDbname()}";
  96.             try {
  97.                 self::$_db = new PDO($dsn, $dbConfig->getUsername(), $dbConfig->getPassword());
  98.             }
  99.             catch (PDOException $e) {
  100.                 $translation = new ZNF_Presentation_Translation('ZNF', $_SESSION['znf']['lang']);
  101.                 throw new ZNF_Business_PDOException($translation->get('errorDbConnection'));
  102.             }
  103.             self::$_tablePrefix = $dbConfig->getTablePrefix();
  104.         }
  105.  
  106.         return self::$_db;
  107.     }
  108.  
  109.     /**
  110.      * Returns the prefix used in the name of the database tables.
  111.      *
  112.      * @static
  113.      * @access public
  114.      * @return string 
  115.      */
  116.     static public function getTablePrefix()
  117.     {
  118.         return self::$_tablePrefix;
  119.     }
  120.  
  121.     /**
  122.      * Destroys the <i>ZNF_Business_PDO</i> object.
  123.      *
  124.      * @access public
  125.      */
  126.     public function __destruct()
  127.     {
  128.     }
  129.  
  130. }
  131.  
  132. /**
  133.  * <i>ZNF_Business_PDOException</i> is the exception type for the <i>ZNF_Business_PDO</i> class.
  134.  *
  135.  * <i>ZNF_Business_PDOException</i> extends the <i>Exception</i> class of PHP5.
  136.  *
  137.  * @access     public
  138.  * @package    ZNF
  139.  * @subpackage Business
  140.  * @author     Alessandro Rossini <http://www.alessandrorossini.org>
  141.  * @author     Graziano Liberati <http://www.liberati.org>
  142.  * @copyright  2004-2007 The ZNF Development Team
  143.  * @license    LGPL License 2.1 <http://www.gnu.org/copyleft/lesser.html>
  144.  * @version    SVN $Id: DB.php 2 2005-10-20 15:54:16Z aronnax $
  145.  * @since      Release 0.7.7
  146.  * @link       http://www.zeronotice.org
  147.  */
  148. class ZNF_Business_PDOException extends Exception
  149. {
  150. }
  151.  
  152. ?>
Documentation generated on Wed, 14 Nov 2007 23:47:38 +0100 by phpDocumentor 1.4.0