1. sfDatabase.class.php
  2. /**
 * sfDatabase is a base abstraction class that allows you to setup any type of
 * database connection via a configuration file.
 *
 * @package    symfony
 * @subpackage database
 * @author     Fabien Potencier 
 * @author     Sean Kerr 
 * @version    SVN: $Id: sfDatabase.class.php 23810 2009-11-12 11:07:44Z Kris.Wallsmith $
 */
  3. abstract class sfDatabase
  4. {
  5.   protected
  6.     $parameterHolder = null,
  7.     $connection      = null,
  8.     $resource        = null;
  10.   /**
  11.    * Class constructor.
  12.    *
  13.    * @see initialize()
  14.    */
  15.   public function __construct($parameters = array())
  16.   {
  17.     $this->initialize($parameters);
  18.   }
  20.   /**
  21.    * Initializes this sfDatabase object.
  22.    *
  23.    * @param array $parameters An associative array of initialization parameters
  24.    *
  25.    * @return bool true, if initialization completes successfully, otherwise false
  26.    *
  27.    * @throws <b>sfInitializationException</b> If an error occurs while initializing this sfDatabase object
  28.    */
  29.   public function initialize($parameters = array())
  30.   {
  31.     $this->parameterHolder = new sfParameterHolder();
  32.     $this->parameterHolder->add($parameters);
  33.   }
  35.   /**
  36.    * Connects to the database.
  37.    *
  38.    * @throws <b>sfDatabaseException</b> If a connection could not be created
  39.    */
  40.   abstract function connect();
  42.   /**
  43.    * Retrieves the database connection associated with this sfDatabase implementation.
  44.    *
  45.    * When this is executed on a Database implementation that isn't an
  46.    * abstraction layer, a copy of the resource will be returned.
  47.    *
  48.    * @return mixed A database connection
  49.    *
  50.    * @throws <b>sfDatabaseException</b> If a connection could not be retrieved
  51.    */
  52.   public function getConnection()
  53.   {
  54.     if (null === $this->connection)
  55.     {
  56.       $this->connect();
  57.     }
  59.     return $this->connection;
  60.   }
  62.   /**
  63.    * Retrieves a raw database resource associated with this sfDatabase implementation.
  64.    *
  65.    * @return mixed A database resource
  66.    *
  67.    * @throws <b>sfDatabaseException</b> If a resource could not be retrieved
  68.    */
  69.   public function getResource()
  70.   {
  71.     if (null === $this->resource)
  72.     {
  73.       $this->connect();
  74.     }
  76.     return $this->resource;
  77.   }
  79.   /**
  80.    * Gets the parameter holder for this object.
  81.    *
  82.    * @return sfParameterHolder A sfParameterHolder instance
  83.    */
  84.   public function getParameterHolder()
  85.   {
  86.     return $this->parameterHolder;
  87.   }
  89.   /**
  90.    * Gets the parameter associated with the given key.
  91.    *
  92.    * This is a shortcut for:
  93.    *
  94.    * <code>$this->getParameterHolder()->get()</code>
  95.    *
  96.    * @param string $name    The key name
  97.    * @param string $default The default value
  98.    *
  99.    * @return string The value associated with the key
  100.    *
  101.    * @see sfParameterHolder
  102.    */
  103.   public function getParameter($name, $default = null)
  104.   {
  105.     return $this->parameterHolder->get($name, $default);
  106.   }
  108.   /**
  109.    * Returns true if the given key exists in the parameter holder.
  110.    *
  111.    * This is a shortcut for:
  112.    *
  113.    * <code>$this->getParameterHolder()->has()</code>
  114.    *
  115.    * @param string $name The key name
  116.    *
  117.    * @return boolean true if the given key exists, false otherwise
  118.    *
  119.    * @see sfParameterHolder
  120.    */
  121.   public function hasParameter($name)
  122.   {
  123.     return $this->parameterHolder->has($name);
  124.   }
  126.   /**
  127.    * Sets the value for the given key.
  128.    *
  129.    * This is a shortcut for:
  130.    *
  131.    * <code>$this->getParameterHolder()->set()</code>
  132.    *
  133.    * @param string $name  The key name
  134.    * @param string $value The value
  135.    *
  136.    * @see sfParameterHolder
  137.    */
  138.   public function setParameter($name, $value)
  139.   {
  140.     $this->parameterHolder->set($name, $value);
  141.   }
  143.   /**
  144.    * Executes the shutdown procedure.
  145.    *
  146.    * @return void
  147.    *
  148.    * @throws <b>sfDatabaseException</b> If an error occurs while shutting down this database
  149.    */
  150.   abstract function shutdown();
  151. }
Debug toolbar