[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * The Auth_OpenID_DatabaseConnection class, which is used to emulate
   5   * a PEAR database connection.
   6   *
   7   * @package OpenID
   8   * @author JanRain, Inc. <openid@janrain.com>
   9   * @copyright 2005-2008 Janrain, Inc.
  10   * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
  11   */
  12  
  13  // Do not allow direct access
  14  defined( '_JEXEC' ) or die( 'Restricted access' );
  15  
  16  /**
  17   * An empty base class intended to emulate PEAR connection
  18   * functionality in applications that supply their own database
  19   * abstraction mechanisms.  See {@link Auth_OpenID_SQLStore} for more
  20   * information.  You should subclass this class if you need to create
  21   * an SQL store that needs to access its database using an
  22   * application's database abstraction layer instead of a PEAR database
  23   * connection.  Any subclass of Auth_OpenID_DatabaseConnection MUST
  24   * adhere to the interface specified here.
  25   *
  26   * @package OpenID
  27   */
  28  class Auth_OpenID_DatabaseConnection {
  29      /**
  30       * Sets auto-commit mode on this database connection.
  31       *
  32       * @param bool $mode True if auto-commit is to be used; false if
  33       * not.
  34       */
  35      function autoCommit($mode)
  36      {
  37      }
  38  
  39      /**
  40       * Run an SQL query with the specified parameters, if any.
  41       *
  42       * @param string $sql An SQL string with placeholders.  The
  43       * placeholders are assumed to be specific to the database engine
  44       * for this connection.
  45       *
  46       * @param array $params An array of parameters to insert into the
  47       * SQL string using this connection's escaping mechanism.
  48       *
  49       * @return mixed $result The result of calling this connection's
  50       * internal query function.  The type of result depends on the
  51       * underlying database engine.  This method is usually used when
  52       * the result of a query is not important, like a DDL query.
  53       */
  54      function query($sql, $params = array())
  55      {
  56      }
  57  
  58      /**
  59       * Starts a transaction on this connection, if supported.
  60       */
  61      function begin()
  62      {
  63      }
  64  
  65      /**
  66       * Commits a transaction on this connection, if supported.
  67       */
  68      function commit()
  69      {
  70      }
  71  
  72      /**
  73       * Performs a rollback on this connection, if supported.
  74       */
  75      function rollback()
  76      {
  77      }
  78  
  79      /**
  80       * Run an SQL query and return the first column of the first row
  81       * of the result set, if any.
  82       *
  83       * @param string $sql An SQL string with placeholders.  The
  84       * placeholders are assumed to be specific to the database engine
  85       * for this connection.
  86       *
  87       * @param array $params An array of parameters to insert into the
  88       * SQL string using this connection's escaping mechanism.
  89       *
  90       * @return mixed $result The value of the first column of the
  91       * first row of the result set.  False if no such result was
  92       * found.
  93       */
  94      function getOne($sql, $params = array())
  95      {
  96      }
  97  
  98      /**
  99       * Run an SQL query and return the first row of the result set, if
 100       * any.
 101       *
 102       * @param string $sql An SQL string with placeholders.  The
 103       * placeholders are assumed to be specific to the database engine
 104       * for this connection.
 105       *
 106       * @param array $params An array of parameters to insert into the
 107       * SQL string using this connection's escaping mechanism.
 108       *
 109       * @return array $result The first row of the result set, if any,
 110       * keyed on column name.  False if no such result was found.
 111       */
 112      function getRow($sql, $params = array())
 113      {
 114      }
 115  
 116      /**
 117       * Run an SQL query with the specified parameters, if any.
 118       *
 119       * @param string $sql An SQL string with placeholders.  The
 120       * placeholders are assumed to be specific to the database engine
 121       * for this connection.
 122       *
 123       * @param array $params An array of parameters to insert into the
 124       * SQL string using this connection's escaping mechanism.
 125       *
 126       * @return array $result An array of arrays representing the
 127       * result of the query; each array is keyed on column name.
 128       */
 129      function getAll($sql, $params = array())
 130      {
 131      }
 132  }
 133  
 134  ?>