| | |
| | | | program/include/rcube_mdb2.php | |
| | | | | |
| | | | This file is part of the Roundcube Webmail client | |
| | | | Copyright (C) 2005-2009, Roundcube Dev. - Switzerland | |
| | | | Copyright (C) 2005-2009, The Roundcube Dev Team | |
| | | | Licensed under the GNU GPL | |
| | | | | |
| | | | PURPOSE: | |
| | |
| | | /** |
| | | * Object constructor |
| | | * |
| | | * @param string DSN for read/write operations |
| | | * @param string Optional DSN for read only operations |
| | | * @param string $db_dsnw DSN for read/write operations |
| | | * @param string $db_dsnr Optional DSN for read only operations |
| | | */ |
| | | function __construct($db_dsnw, $db_dsnr='', $pconn=false) |
| | | { |
| | |
| | | /** |
| | | * Connect to specific database |
| | | * |
| | | * @param string DSN for DB connections |
| | | * @return object PEAR database handle |
| | | * @param string $dsn DSN for DB connections |
| | | * @return MDB2 PEAR database handle |
| | | * @access private |
| | | */ |
| | | private function dsn_connect($dsn) |
| | |
| | | /** |
| | | * Connect to appropiate database depending on the operation |
| | | * |
| | | * @param string Connection mode (r|w) |
| | | * @param string $mode Connection mode (r|w) |
| | | * @access public |
| | | */ |
| | | function db_connect($mode) |
| | |
| | | /** |
| | | * Activate/deactivate debug mode |
| | | * |
| | | * @param boolean True if SQL queries should be logged |
| | | * @param boolean $dbg True if SQL queries should be logged |
| | | * @access public |
| | | */ |
| | | function set_debug($dbg = true) |
| | |
| | | $params = func_get_args(); |
| | | $query = array_shift($params); |
| | | |
| | | // Support one argument of type array, instead of n arguments |
| | | if (count($params) == 1 && is_array($params[0])) |
| | | $params = $params[0]; |
| | | |
| | | return $this->_query($query, 0, 0, $params); |
| | | } |
| | | |
| | |
| | | /** |
| | | * Execute a SQL query with limits |
| | | * |
| | | * @param string SQL query to execute |
| | | * @param number Offset for LIMIT statement |
| | | * @param number Number of rows for LIMIT statement |
| | | * @param array Values to be inserted in query |
| | | * @param string $query SQL query to execute |
| | | * @param number $offset Offset for LIMIT statement |
| | | * @param number $numrows Number of rows for LIMIT statement |
| | | * @param array $params Values to be inserted in query |
| | | * @return number Query handle identifier |
| | | * @access private |
| | | */ |
| | |
| | | * Get number of rows for a SQL query |
| | | * If no query handle is specified, the last query will be taken as reference |
| | | * |
| | | * @param number Optional query handle identifier |
| | | * @param number $res_id Optional query handle identifier |
| | | * @return mixed Number of rows or false on failure |
| | | * @access public |
| | | */ |
| | |
| | | /** |
| | | * Get number of affected rows for the last query |
| | | * |
| | | * @param number Optional query handle identifier |
| | | * @param number $res_id Optional query handle identifier |
| | | * @return mixed Number of rows or false on failure |
| | | * @access public |
| | | */ |
| | |
| | | * Get last inserted record ID |
| | | * For Postgres databases, a sequence name is required |
| | | * |
| | | * @param string Table name (to find the incremented sequence) |
| | | * @param string $table Table name (to find the incremented sequence) |
| | | * @return mixed ID or false on failure |
| | | * @access public |
| | | */ |
| | |
| | | * Get an associative array for one row |
| | | * If no query handle is specified, the last query will be taken as reference |
| | | * |
| | | * @param number Optional query handle identifier |
| | | * @param number $res_id Optional query handle identifier |
| | | * @return mixed Array with col values or false on failure |
| | | * @access public |
| | | */ |
| | |
| | | * Get an index array for one row |
| | | * If no query handle is specified, the last query will be taken as reference |
| | | * |
| | | * @param number Optional query handle identifier |
| | | * @param number $res_id Optional query handle identifier |
| | | * @return mixed Array with col values or false on failure |
| | | * @access public |
| | | */ |
| | |
| | | /** |
| | | * Get col values for a result row |
| | | * |
| | | * @param object Query result handle |
| | | * @param number Fetch mode identifier |
| | | * @param MDB2_Result_Common Query $result result handle |
| | | * @param number $mode Fetch mode identifier |
| | | * @return mixed Array with col values or false on failure |
| | | * @access private |
| | | */ |
| | |
| | | /** |
| | | * Formats input so it can be safely used in a query |
| | | * |
| | | * @param mixed Value to quote |
| | | * @param string Type of data |
| | | * @param mixed $input Value to quote |
| | | * @param string $type Type of data |
| | | * @return string Quoted/converted string for use in query |
| | | * @access public |
| | | */ |
| | |
| | | /** |
| | | * Quotes a string so it can be safely used as a table or column name |
| | | * |
| | | * @param string Value to quote |
| | | * @param string $str Value to quote |
| | | * @return string Quoted string for use in query |
| | | * @deprecated Replaced by rcube_MDB2::quote_identifier |
| | | * @see rcube_mdb2::quote_identifier |
| | |
| | | /** |
| | | * Quotes a string so it can be safely used as a table or column name |
| | | * |
| | | * @param string Value to quote |
| | | * @param string $str Value to quote |
| | | * @return string Quoted string for use in query |
| | | * @access public |
| | | */ |
| | |
| | | /** |
| | | * Escapes a string |
| | | * |
| | | * @param string The string to be escaped |
| | | * @param string $str The string to be escaped |
| | | * @return string The escaped string |
| | | * @access public |
| | | * @since 0.1.1 |
| | |
| | | /** |
| | | * Return list of elements for use with SQL's IN clause |
| | | * |
| | | * @param array Input array |
| | | * @param string Type of data |
| | | * @param array $arr Input array |
| | | * @param string $type Type of data |
| | | * @return string Comma-separated list of quoted values for use in query |
| | | * @access public |
| | | */ |
| | |
| | | /** |
| | | * Return SQL statement to convert a field value into a unix timestamp |
| | | * |
| | | * @param string Field name |
| | | * @param string $field Field name |
| | | * @return string SQL statement to use in query |
| | | * @access public |
| | | */ |
| | |
| | | /** |
| | | * Return SQL statement to convert from a unix timestamp |
| | | * |
| | | * @param string Field name |
| | | * @param string $timestamp Field name |
| | | * @return string SQL statement to use in query |
| | | * @access public |
| | | */ |
| | |
| | | /** |
| | | * Return SQL statement for case insensitive LIKE |
| | | * |
| | | * @param string Field name |
| | | * @param string Search value |
| | | * @param string $column Field name |
| | | * @param string $value Search value |
| | | * @return string SQL statement to use in query |
| | | * @access public |
| | | */ |
| | |
| | | /** |
| | | * Encodes non-UTF-8 characters in string/array/object (recursive) |
| | | * |
| | | * @param mixed Data to fix |
| | | * @param mixed $input Data to fix |
| | | * @return mixed Properly UTF-8 encoded data |
| | | * @access public |
| | | */ |
| | |
| | | /** |
| | | * Decodes encoded UTF-8 string/object/array (recursive) |
| | | * |
| | | * @param mixed Input data |
| | | * @param mixed $input Input data |
| | | * @return mixed Decoded data |
| | | * @access public |
| | | */ |
| | |
| | | /** |
| | | * Adds a query result and returns a handle ID |
| | | * |
| | | * @param object Query handle |
| | | * @param object $res Query handle |
| | | * @return mixed Handle ID |
| | | * @access private |
| | | */ |
| | |
| | | * Resolves a given handle ID and returns the according query handle |
| | | * If no ID is specified, the last resource handle will be returned |
| | | * |
| | | * @param number Handle ID |
| | | * @param number $res_id Handle ID |
| | | * @return mixed Resource handle or false on failure |
| | | * @access private |
| | | */ |
| | |
| | | /** |
| | | * Create a sqlite database from a file |
| | | * |
| | | * @param object SQLite database handle |
| | | * @param string File path to use for DB creation |
| | | * @param MDB2 $dbh SQLite database handle |
| | | * @param string $file_name File path to use for DB creation |
| | | * @access private |
| | | */ |
| | | private function _sqlite_create_database($dbh, $file_name) |