initial commit

lib/symfony/database/sfMySQLDatabase.class.php

@@ -0,0 +1,166 @@
+<?php
+
+/*
+ * This file is part of the symfony package.
+ * (c) 2004-2006 Fabien Potencier <fabien.potencier@symfony-project.com>
+ * (c) 2004-2006 Sean Kerr.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+/**
+ * sfMySQLDatabase provides connectivity for the MySQL brand database.
+ *
+ * <b>Optional parameters:</b>
+ *
+ * # <b>database</b>   - [none]      - The database name.
+ * # <b>host</b>       - [localhost] - The database host.
+ * # <b>method</b>     - [normal]    - How to read connection parameters.
+ *                                     Possible values are normal, server, and
+ *                                     env. The normal method reads them from
+ *                                     the specified values. server reads them
+ *                                     from $_SERVER where the keys to retrieve
+ *                                     the values are what you specify the value
+ *                                     as in the settings. env reads them from
+ *                                     $_ENV and works like $_SERVER.
+ * # <b>password</b>   - [none]      - The database password.
+ * # <b>persistent</b> - [No]        - Indicates that the connection should be
+ *                                     persistent.
+ * # <b>username</b>       - [none]  - The database username.
+ *
+ * @package    symfony
+ * @subpackage database
+ * @author     Fabien Potencier <fabien.potencier@symfony-project.com>
+ * @author     Sean Kerr <skerr@mojavi.org>
+ * @version    SVN: $Id: sfMySQLDatabase.class.php 3329 2007-01-23 08:29:34Z fabien $
+ */
+class sfMySQLDatabase extends sfDatabase
+{
+  /**
+   * Connects to the database.
+   *
+   * @throws <b>sfDatabaseException</b> If a connection could not be created
+   */
+  public function connect()
+  {
+
+    // determine how to get our
+    $method = $this->getParameter('method', 'normal');
+
+    switch ($method)
+    {
+      case 'normal':
+        // get parameters normally
+        $database = $this->getParameter('database');
+        $host     = $this->getParameter('host', 'localhost');
+        $password = $this->getParameter('password');
+        $username = $this->getParameter('username');
+
+        break;
+
+      case 'server':
+        // construct a connection string from existing $_SERVER values
+        // and extract them to local scope
+        $parameters =& $this->loadParameters($_SERVER);
+        extract($parameters);
+
+        break;
+
+      case 'env':
+        // construct a connection string from existing $_ENV values
+        // and extract them to local scope
+        $string =& $this->loadParameters($_ENV);
+        extract($parameters);
+
+        break;
+
+      default:
+        // who knows what the user wants...
+        $error = 'Invalid MySQLDatabase parameter retrieval method "%s"';
+        $error = sprintf($error, $method);
+
+        throw new sfDatabaseException($error);
+    }
+
+    // let's see if we need a persistent connection
+    $persistent = $this->getParameter('persistent', false);
+    $connect    = ($persistent) ? 'mysql_pconnect' : 'mysql_connect';
+
+    if ($password == null)
+    {
+      if ($username == null)
+      {
+        $this->connection = @$connect($host);
+      }
+      else
+      {
+        $this->connection = @$connect($host, $username);
+      }
+    }
+    else
+    {
+      $this->connection = @$connect($host, $username, $password);
+    }
+
+    // make sure the connection went through
+    if ($this->connection === false)
+    {
+      // the connection's foobar'd
+      $error = 'Failed to create a MySQLDatabase connection';
+
+      throw new sfDatabaseException($error);
+    }
+
+    // select our database
+    if ($database != null && !@mysql_select_db($database, $this->connection))
+    {
+      // can't select the database
+      $error = 'Failed to select MySQLDatabase "%s"';
+      $error = sprintf($error, $database);
+
+      throw new sfDatabaseException($error);
+    }
+
+    // since we're not an abstraction layer, we copy the connection
+    // to the resource
+    $this->resource = $this->connection;
+  }
+
+  /**
+   * Loads connection parameters from an existing array.
+   *
+   * @return array An associative array of connection parameters
+   */
+  protected function & loadParameters(&$array)
+  {
+    // list of available parameters
+    $available = array('database', 'host', 'password', 'user');
+
+    $parameters = array();
+
+    foreach ($available as $parameter)
+    {
+      $$parameter = $this->getParameter($parameter);
+
+      $parameters[$parameter] = ($$parameter != null) ? $array[$$parameter] : null;
+    }
+
+    return $parameters;
+  }
+
+  /**
+   * Execute the shutdown procedure
+   *
+   * @return void
+   *
+   * @throws <b>sfDatabaseException</b> If an error occurs while shutting down this database
+   */
+  public function shutdown()
+  {
+    if ($this->connection != null)
+    {
+      @mysql_close($this->connection);
+    }
+  }
+}