Koowa_Database
[ class tree: Koowa_Database ] [ index: Koowa_Database ] [ all elements ]
Packages:
default
Koowa_Behavior
Koowa_Command
Koowa_Config
Koowa_Controller
Koowa_Database
Koowa_Date
Koowa_Dispatcher
Koowa_Event
Koowa_Exception
Koowa_Filter
Koowa_Helper
Koowa_Http
Koowa_Inflector
Koowa_Loader
Koowa_Mixin
Koowa_Model
Koowa_Object
Koowa_Plugins
Koowa_Request
Koowa_Service
Koowa_Template
Koowa_View
Nooku_Components
Nooku_Filter
Nooku_Module
Nooku_Modules
Nooku_Plugins

Source for file interface.php

Documentation is available at interface.php

  1. <?php
  2. /**
  3.  * @version        $Id: interface.php 4628 2012-05-06 19:56:43Z johanjanssens $
  4.  * @package     Koowa_Database
  5.  * @subpackage  Adapter
  6.  * @copyright    Copyright (C) 2007 - 2012 Johan Janssens. All rights reserved.
  7.  * @license        GNU GPLv3 <http://www.gnu.org/licenses/gpl.html>
  8.  * @link         http://www.nooku.org
  9.  */
  10.  
  11. /**
  12.  * Database Adapter Interface
  13.  *
  14.  * @author        Johan Janssens <johan@nooku.org>
  15.  * @package     Koowa_Database
  16.  * @subpackage  Adapter
  17.  */
  18. interface KDatabaseAdapterInterface
  19. {
  20.     /**
  21.      * Get a database query object
  22.      *
  23.      * @return KDatabaseQuery 
  24.      */
  25.     public function getQuery(KConfig $config = null);
  26.  
  27.     /**
  28.      * Connect to the db
  29.      *
  30.      * @return  KDatabaseAdapterAbstract 
  31.      */
  32.     public function connect();
  33.  
  34.     /**
  35.      * Reconnect to the db
  36.      *
  37.      * @return  KDatabaseAdapterAbstract 
  38.      */
  39.     public function reconnect();
  40.  
  41.     /**
  42.      * Disconnect from db
  43.      *
  44.      * @return  KDatabaseAdapterAbstract 
  45.      */
  46.     public function disconnect();
  47.  
  48.     /**
  49.      * Get the connection
  50.      *
  51.      * Provides access to the underlying database connection. Useful for when
  52.      * you need to call a proprietary method such as postgresql's lo_* methods
  53.      *
  54.      * @return resource 
  55.      */
  56.     public function getConnection();
  57.  
  58.     /**
  59.      * Set the connection
  60.      *
  61.      * @param     resource     The connection resource
  62.      * @return  KDatabaseAdapterAbstract 
  63.      */
  64.     public function setConnection($resource);
  65.  
  66.     /**
  67.      * Determines if the connection to the server is active.
  68.      *
  69.      * @return      boolean 
  70.      */
  71.     public function isConnected();
  72.  
  73.     /**
  74.      * Get the insert id of the last insert operation
  75.      *
  76.      * @return mixed The id of the last inserted row(s)
  77.      */
  78.      public function getInsertId();
  79.  
  80.     /**
  81.      * Retrieves the column schema information about the given table
  82.      *
  83.      * @param     string     A table name
  84.      * @return    KDatabaseSchemaTable 
  85.      */
  86.     public function getTableSchema($table);
  87.  
  88.     /**
  89.      * Lock a table.
  90.      *
  91.      * @param  string  Base name of the table.
  92.      * @param  string  Real name of the table.
  93.      * @return boolean True on success, false otherwise.
  94.      */
  95.     public function lockTable($base, $name);
  96.  
  97.     /**
  98.      * Unlock a table.
  99.      *
  100.      * @return boolean True on success, false otherwise.
  101.      */
  102.     public function unlockTable();
  103.  
  104.     /**
  105.      * Preforms a select query
  106.      *
  107.      * Use for SELECT and anything that returns rows.
  108.      *
  109.      * @param    string      A full SQL query to run. Data inside the query should be properly escaped.
  110.      * @param    integer     The result maode, either the constant KDatabase::RESULT_USE or KDatabase::RESULT_STORE
  111.      *                          depending on the desired behavior. By default, KDatabase::RESULT_STORE is used. If you
  112.      *                          use KDatabase::RESULT_USE all subsequent calls will return error Commands out of sync
  113.      *                          unless you free the result first.
  114.      * @return  mixed         If successfull returns a result object otherwise FALSE
  115.      */
  116.     public function select($sql, $mode = KDatabase::RESULT_STORE);
  117.  
  118.     /**
  119.      * Preforms a show query
  120.      *
  121.      * @param    string|object       A full SQL query to run. Data inside the query should be properly escaped.
  122.      * @param   integer            The fetch mode. Controls how the result will be returned to the caller. This
  123.      *                              value must be one of the KDatabase::FETCH_* constants.
  124.      * @return  mixed             The return value of this function on success depends on the fetch type.
  125.      *                              In all cases, FALSE is returned on failure.
  126.      */
  127.     public function show($query, $mode = KDatabase::FETCH_ARRAY_LIST);
  128.  
  129.     /**
  130.      * Inserts a row of data into a table.
  131.      *
  132.      * Automatically quotes the data values
  133.      *
  134.      * @param string      The table to insert data into.
  135.      * @param array     An associative array where the key is the colum name and
  136.      *                      the value is the value to insert for that column.
  137.      * @return integer  If successfull the new rows primary key value, false is no row was inserted.
  138.      */
  139.     public function insert($table, array $data);
  140.  
  141.     /**
  142. /**
  143.      * Updates a table with specified data based on a WHERE clause
  144.      *
  145.      * Automatically quotes the data values
  146.      *
  147.      * @param string     The table to update
  148.      * @param array      An associative array where the key is the column name and
  149.      *                       the value is the value to use ofr that column.
  150.      * @param mixed     A sql string or KDatabaseQuery object to limit which rows are updated.
  151.      * @return integer  If successfull the Number of rows affected, otherwise false
  152.      */
  153.     public function update($table, array $data, $where = null);
  154.  
  155.     /**
  156. /**
  157.      * Deletes rows from the table based on a WHERE clause.
  158.      *
  159.      * @param string The table to update
  160.      * @param mixed  A query string or a KDatabaseQuery object to limit which rows are updated.
  161.      * @return integer Number of rows affected
  162.      */
  163.     public function delete($table, $where);
  164.  
  165.     /**
  166.      * Use and other queries that don't return rows
  167.      *
  168.      * @param  string     The query to run. Data inside the query should be properly escaped.
  169.      * @param  integer     The result maode, either the constant KDatabase::RESULT_USE or KDatabase::RESULT_STORE
  170.      *                      depending on the desired behavior. By default, KDatabase::RESULT_STORE is used. If you
  171.      *                      use KDatabase::RESULT_USE all subsequent calls will return error Commands out of sync
  172.      *                      unless you free the result first.
  173.      * @throws KDatabaseException
  174.      * @return boolean     For SELECT, SHOW, DESCRIBE or EXPLAIN will return a result object.
  175.      *                      For other successful queries  return TRUE.
  176.      */
  177.     public function execute($sql, $mode = KDatabase::RESULT_STORE );
  178.  
  179.     /**
  180.      * Set the table prefix
  181.      *
  182.      * @param string The table prefix
  183.      * @return KDatabaseAdapterAbstract 
  184.      * @see KDatabaseAdapterAbstract::replaceTableNeedle
  185.      */
  186.     public function setTablePrefix($prefix);
  187.  
  188.      /**
  189.      * Get the table prefix
  190.      *
  191.      * @return string The table prefix
  192.      * @see KDatabaseAdapterAbstract::replaceTableNeedle
  193.      */
  194.     public function getTablePrefix();
  195.  
  196.     /**
  197.      * Get the table needle
  198.      *
  199.      * @return string The table needle
  200.      * @see KDatabaseAdapterAbstract::replaceTableNeedle
  201.      */
  202.     public function getTableNeedle();
  203.  
  204.     /**
  205.      * This function replaces the table needles in a query string with the actual table prefix.
  206.      *
  207.      * @param  string     The SQL query string
  208.      * @return string    The SQL query string
  209.      */
  210.     public function replaceTableNeedle( $sql );
  211.  
  212.     /**
  213.      * Safely quotes a value for an SQL statement.
  214.      *
  215.      * If an array is passed as the value, the array values are quoted
  216.      * and then returned as a comma-separated string; this is useful
  217.      * for generating IN() lists.
  218.      *
  219.      * @param   mixed The value to quote.
  220.      * @return string An SQL-safe quoted value (or a string of separated-
  221.      *                 and-quoted values).
  222.      */
  223.     public function quoteValue($value);
  224.  
  225.     /**
  226.      * Quotes a single identifier name (table, table alias, table column,
  227.      * index, sequence).  Ignores empty values.
  228.      *
  229.      * This function requires all SQL statements, operators and functions to be
  230.      * uppercased.
  231.      *
  232.      * @param string|arrayThe identifier name to quote.  If an array, quotes
  233.      *                       each element in the array as an identifier name.
  234.      * @return string|arrayThe quoted identifier name (or array of names).
  235.      */
  236.     public function quoteName($spec);
  237. }
Documentation generated on Sun, 19 May 2013 03:03:58 +0200 by phpDocumentor 1.4.3