diff options
| -rw-r--r-- | modules/database/classes/database/expression.php | 35 | ||||
| -rw-r--r-- | modules/database/classes/database/query.php | 508 | ||||
| -rw-r--r-- | modules/database/classes/db.php | 163 |
3 files changed, 375 insertions, 331 deletions
diff --git a/modules/database/classes/database/expression.php b/modules/database/classes/database/expression.php index e987d52..a041967 100644 --- a/modules/database/classes/database/expression.php +++ b/modules/database/classes/database/expression.php @@ -5,28 +5,29 @@ * inside the query
* @package Database
*/
-class Expression_Database{
-
+class Expression_Database
+{
/**
* Part of query that should not be escaped
- * @var mixed
- * @access public
+ * @var mixed
+ * @access public
*/
- public $value;
+ public $value;
/**
* Marks a part of query as a database specific expression,
- * e.g. calls to SQL functions like MAX(), SUBSTR() etc.
- * Example
- * <code>
- * $q->fields(DB::expr('COUNT(*)'));
- * </code>
- *
+ * e.g. calls to SQL functions like MAX(), SUBSTR() etc.
+ * Example
+ * <code>
+ * $q->fields(DB::expr('COUNT(*)'));
+ * </code>
+ *
* @param mixed $value Part of query that should not be escaped
- * @return Expression_Database
- * @access public
+ * @return Expression_Database
+ * @access public
*/
- public function __construct($value){
- $this->value=$value;
- }
-}
\ No newline at end of file + public function __construct($value)
+ {
+ $this->value = $value;
+ }
+}
diff --git a/modules/database/classes/database/query.php b/modules/database/classes/database/query.php index 981a33c..5c905ae 100644 --- a/modules/database/classes/database/query.php +++ b/modules/database/classes/database/query.php @@ -5,7 +5,7 @@ * Database drivers extend this class so that they can generate database specific queries. * The idea is to provide a database agnostic interface to query writing. * - * @method mixed table(string $table = null) Set table to query. + * @method mixed table(string $table = null) Set table to query. * Without arguments returns current table, returns self otherwise. * * @method mixed data(array $data = null) Set data for insert or update queries. @@ -27,363 +27,397 @@ * Without arguments returns current type argument, returns self otherwise. * @package Database */ -abstract class Query_Database { - +abstract class Query_Database +{ /** * Array of conditions that rows must meet - * @var array - * @access protected + * @var array + * @access protected */ - protected $_conditions = array(); + protected $_conditions = array(); /** * Table to query - * @var unknown - * @access protected + * @var unknown + * @access protected */ - protected $_table; + protected $_table; /** * Fields to return in the query - * @var array - * @access protected + * @var array + * @access protected */ - protected $_fields; + protected $_fields; /** * Data for row insertion or update - * @var unknown - * @access protected + * @var unknown + * @access protected */ - protected $_data; + protected $_data; /** * Query type. Available types: select, update, insert, delete, count - * @var string - * @access protected + * @var string + * @access protected */ - protected $_type; + protected $_type; /** * Parameters for tables to join - * @var array - * @access protected + * @var array + * @access protected */ - protected $_joins = array(); + protected $_joins = array(); /** * Number of rows to return - * @var int - * @access protected + * @var int + * @access protected */ - protected $_limit; + protected $_limit; /** * Offset of the first row - * @var int - * @access protected + * @var int + * @access protected */ - protected $_offset; + protected $_offset; /** * Columns and directions to order by - * @var array - * @access protected + * @var array + * @access protected */ - protected $_orderby = array(); + protected $_orderby = array(); /** * Database connection - * @var DB - * @access protected + * @var DB + * @access protected */ - protected $_db; + protected $_db; /** * Conditions for aggregator functions - * @var array - * @access protected + * @var array + * @access protected */ - protected $_having=array(); + protected $_having = array(); /** * Column to group by for aggregator functions - * @var string - * @access protected + * @var string + * @access protected */ - protected $_group_by; + protected $_group_by; /** * Last alias used on the table - * @var string - * @access protected + * @var string + * @access protected */ - protected $_alias = null; + protected $_alias = null; /** * Methods and type of value they allow that are available via __call - * @var array - * @access protected + * @var array + * @access protected */ - protected $methods = array('table' => 'string','data' => 'array','limit' => array('integer','NULL'),'offset' => array('integer','NULL'),'group_by' => array('string','NULL'),'type' => 'string'); + protected $methods = array('table' => 'string', 'data' => 'array', 'limit' => array('integer', 'NULL'), 'offset' => array('integer','NULL'), 'group_by' => array('string', 'NULL'), 'type' => 'string'); /** * Generates a query in format that can be executed on current database implementation - * - * @access public + * + * @access public */ - public abstract function query(); + public abstract function query(); /** * Creates a new query - * + * * @param DB $db Database connection * @param string $type Query type. Available types: select, update, insert, delete, count - * @return void - * @access public + * @return void + * @access public */ - public function __construct($db, $type) { - $this->_db=$db; - $this->_type=$type; - } + public function __construct($db, $type) + { + $this->_db = $db; + $this->_type = $type; + } /** * Sets fields to be queried from the database. You can add aliases to the fields - * by passing them as: - * - * array('field_name','alias') + * by passing them as: * - * Example: $query->fields('id', array('name', 'fairy_name')) - * - * @param mixed $field,... Fields to be selected from the table + * array('field_name','alias') + * + * Example: $query->fields('id', array('name', 'fairy_name')) + * + * @param mixed $field,... Fields to be selected from the table * @return mixed If no parameters are passed returns current array of fields, - * otherwise returns self. - * @access public + * otherwise returns self. + * @access public */ - public function fields() { - $p = func_get_args(); - if (empty($p)) { - return $this->_fields; - }else{ - $this->_fields=$p; - } - return $this; - } + public function fields() + { + $p = func_get_args(); + if (empty($p)) + { + return $this->_fields; + } + else + { + $this->_fields=$p; + } + return $this; + } /** * Magic methods to create methods for all generic query parts - * + * * @param string $method Name of the method to call * @param array $args Array of parameters * @return mixed If no arguments are passed returns the current value of the property, - * otherwise returns self. - * @access public + * otherwise returns self. + * @access public * @throws Exception If method doesn't exist - * @throws Exception If value is of incorrect type - * @see $methods + * @throws Exception If value is of incorrect type + * @see $methods */ - public function __call($method, $args) { - if (isset($this->methods[$method])) { - - $property = '_'.$method; - - if (empty($args)) - return $this->$property; - $val = $args[0]; - if (is_numeric($val)) - $val = (int) $val; - $allowed_types = $this->methods[$method]; - if (!is_array($allowed_types)) - $allowed_types=array($allowed_types); - if (!in_array(gettype($val),$allowed_types)) - throw new Exception("Method '{$method}' only accepts values of type: ".implode(' or ',$allowed_types).", '{$val}' was passed"); - $this->$property = $val; - return $this; - } - throw new Exception("Method '{$method}' doesn't exist."); - } + public function __call($method, $args) + { + if (isset($this->methods[$method])) + { + $property = '_'.$method; + + if (empty($args)) + { + return $this->$property; + } + $val = $args[0]; + if (is_numeric($val)) + { + $val = (int) $val; + } + $allowed_types = $this->methods[$method]; + if (!is_array($allowed_types)) + { + $allowed_types=array($allowed_types); + } + if (!in_array(gettype($val), $allowed_types)) + { + throw new Exception("Method '{$method}' only accepts values of type: ".implode(' or ',$allowed_types).", '{$val}' was passed"); + } + $this->$property = $val; + return $this; + } + throw new Exception("Method '{$method}' doesn't exist."); + } /** * Executes the query - * + * * @return object Executes current query on its database connection - * @access public - * @see DB + * @access public + * @see DB */ - public function execute() { - $query = $this->query(); - $result = $this->_db->execute($query[0], $query[1]); - if ($this->_type == 'count') - return $result->get('count'); - return $result; - } - + public function execute() + { + $query = $this->query(); + $result = $this->_db->execute($query[0], $query[1]); + if ($this->_type == 'count') + { + return $result->get('count'); + } + return $result; + } + /** * Adds a joined table to the query. - * + * * @param string $table Table to join * @param array $conds Conditions to join tables on, same behavior as with where() method * @param string $type Type of join. Defaults to 'left' * @return Query_Database Returns self - * @access public - * @see where() + * @access public + * @see where() */ - public function join($table,$conds,$type='left'){ - $this->_joins[] = array($table, $type, $this->get_condition_part($conds)); - return $this; - } - + public function join($table,$conds,$type='left') + { + $this->_joins[] = array($table, $type, $this->get_condition_part($conds)); + return $this; + } + /** * Sets conditions for aggregate functions, same behavior as with where() method - * + * * @return Query_Database Returns self - * @access public - * @see where() + * @access public + * @see where() */ - public function having() { - $p = func_get_args(); - $cond = $this->get_condition_part($p); - $this->_having = array_merge($this->_having,array($cond)); - return $this; - } + public function having() + { + $p = func_get_args(); + $cond = $this->get_condition_part($p); + $this->_having = array_merge($this->_having, array($cond)); + return $this; + } /** * Adds a column to ordering parameters. - * + * * @param string $column Column to order by * @param string $dir Ordering direction. * @return Query_Database Returns self - * @throws Exception If ordering direction isn't DESC or ASC - * @access public + * @throws Exception If ordering direction isn't DESC or ASC + * @access public */ - public function order_by($column, $dir) { - $dir=strtoupper($dir); - if ($dir != 'DESC' && $dir != 'ASC') - throw new Exception("Invalid sorting direction {$dir} specified"); - $this->_orderby[]=array($column,$dir); - return $this; - } + public function order_by($column, $dir) + { + $dir = strtoupper($dir); + if ($dir != 'DESC' && $dir != 'ASC') + { + throw new Exception("Invalid sorting direction {$dir} specified"); + } + $this->_orderby[] = array($column,$dir); + return $this; + } /** * Sets conditions for the query. - * Can be called in many ways, examples: - * Shorthand equals condition: - * <code> - * $q->where('name', 'Tinkerbell') - * </code> - * Conditions with operator: - * <code> - * $q->where('id', '>', 3) - * </code> - * OR logic: - * <code> - * $q->where('or', array('name', 'Tinkerbell')) - * </code> - * OR logic with operator - * <code> - * ->where('or', array('id', '>', 3)) - * </code> - * Arrays represent brackets. e.g - * <code> - * $q->where('name', 'Tinkerbell') - * ->where('or', array( - * array('id', '>', 7), - * array('id', '<', 15) - * ); - * //Will produce "WHERE `name`='Tinkerbell' OR (`id` > 7 AND `id` < 15)" - * </code> - * Multiple calls to where() append new conditions to previous ones - * - * @param mixed $column Column name, logic parameter 'OR' or 'AND' or an array of conditions - * @param mixed $operator Condition value, operator or an array of parameters - * @param mixed $val Condition value - * + * Can be called in many ways, examples: + * Shorthand equals condition: + * <code> + * $q->where('name', 'Tinkerbell') + * </code> + * Conditions with operator: + * <code> + * $q->where('id', '>', 3) + * </code> + * OR logic: + * <code> + * $q->where('or', array('name', 'Tinkerbell')) + * </code> + * OR logic with operator + * <code> + * ->where('or', array('id', '>', 3)) + * </code> + * Arrays represent brackets. e.g + * <code> + * $q->where('name', 'Tinkerbell') + * ->where('or', array( + * array('id', '>', 7), + * array('id', '<', 15) + * ); + * //Will produce "WHERE `name`='Tinkerbell' OR (`id` > 7 AND `id` < 15)" + * </code> + * Multiple calls to where() append new conditions to previous ones + * + * @param mixed $column Column name, logic parameter 'OR' or 'AND' or an array of conditions + * @param mixed $operator Condition value, operator or an array of parameters + * @param mixed $val Condition value + * * @return Query_Database Returns self - * @access public + * @access public */ - public function where() { - $p = func_get_args(); - $cond = $this->get_condition_part($p); - $this->_conditions= array_merge($this->_conditions,array($cond)); - - return $this; - } + public function where() + { + $p = func_get_args(); + $cond = $this->get_condition_part($p); + $this->_conditions = array_merge($this->_conditions, array($cond)); + + return $this; + } /** * Recursively builds condition arrays for methods like where(), having() - * + * * @param array $p Parameters passed to the method * @return array Array in condition format - * @access private + * @access private * @throws Exception If condition format is incorrect */ - private function get_condition_part($p) { - if (is_string($p[0]) && (strtolower($p[0]) == 'or'||strtolower($p[0]) == 'and') && isset($p[1]) && is_array($p[1])) { - $cond = $this->get_condition_part($p[1]); - $cond['logic'] = strtolower($p[0]); - return $cond; - } - - if (is_array($p[0])) { - if (count($p) == 1) - return $this->get_condition_part($p[0]); - $conds = array(); - foreach($p as $q) { - $conds[]=$this->get_condition_part($q); - } - if (count($conds) == 1) - return $conds; - return array('logic'=>'and','conditions'=>$conds); - } - - - if ((is_string($p[0]) || get_class($p[0]) == 'Expression_Database') && isset($p[1])) { - if (strpos($p[0], '.') === false) - $p[0]=$this->last_alias().'.'.$p[0]; - return array( - 'logic' => 'and', - 'conditions'=>array( - 'field' => $p[0], - 'operator' => isset($p[2])?$p[1]:'=', - 'value' => isset($p[2])?$p[2]:$p[1] - ) - ); - } - - throw new Exception('Incorrect conditional statement passed'); - } + private function get_condition_part($p) + { + if (is_string($p[0]) && (strtolower($p[0]) == 'or' || strtolower($p[0]) == 'and') && isset($p[1]) && is_array($p[1])) + { + $cond = $this->get_condition_part($p[1]); + $cond['logic'] = strtolower($p[0]); + return $cond; + } + + if (is_array($p[0])) + { + if (count($p) == 1) + { + return $this->get_condition_part($p[0]); + } + $conds = array(); + foreach($p as $q) + { + $conds[] = $this->get_condition_part($q); + } + if (count($conds) == 1) + { + return $conds; + } + return array('logic' => 'and', 'conditions' => $conds); + } + + if ((is_string($p[0]) || get_class($p[0]) == 'Expression_Database') && isset($p[1])) + { + if (strpos($p[0], '.') === false) + { + $p[0]=$this->last_alias().'.'.$p[0]; + } + return array( + 'logic' => 'and', + 'conditions' => array( + 'field' => $p[0], + 'operator' => isset($p[2]) ? $p[1] : '=', + 'value' => isset($p[2]) ? $p[2] : $p[1] + ) + ); + } + + throw new Exception('Incorrect conditional statement passed'); + } /** * Gets last generated alias - * + * * @return string Last generated alias. If no alias were created returns table name. - * @access public + * @access public */ - public function last_alias() { - if ($this->_alias === null) - return $this->_table; - return 'a'.$this->_alias; - } + public function last_alias() + { + if ($this->_alias === null) + { + return $this->_table; + } + return 'a'.$this->_alias; + } /** * Generates new alias. Useful for dynamically adding aliases to joins. - * Alias is just a letter 'a' with an incremented number. - * + * Alias is just a letter 'a' with an incremented number. + * * @return string New alias - * @access public + * @access public */ - public function add_alias() { - if ($this->_alias === null){ - $this->_alias = 0; - }else { - $this->_alias++; - } - return $this->last_alias(); - } - - - - - - -}
\ No newline at end of file + public function add_alias() + { + if ($this->_alias === null) + { + $this->_alias = 0; + } + else + { + $this->_alias++; + } + return $this->last_alias(); + } +} diff --git a/modules/database/classes/db.php b/modules/database/classes/db.php index dd24056..42e8534 100644 --- a/modules/database/classes/db.php +++ b/modules/database/classes/db.php @@ -6,133 +6,142 @@ * generic connection class used by drivers. * @package Database */ -abstract class DB { - +abstract class DB +{ /** * An associative array of connections to databases - * @var array - * @access private - * @static + * @var array + * @access private + * @static */ - private static $_instances=array(); + private static $_instances = array(); /** * Executes a prepared statement query - * + * * @param string $query A prepared statement query * @param array $params Parameters for the query - * @return Result_Database - * @access public - * @see Result_Database + * @return Result_Database + * @access public + * @see Result_Database */ - public abstract function execute($query, $params = array()); + public abstract function execute($query, $params = array()); /** * Builds a new Query to the database - * + * * @param string $type Query type. Available types: select, update, insert, delete, count - * @return Result_Database - * @access public - * @see Query_Database + * @return Result_Database + * @access public + * @see Query_Database */ - public abstract function build_query($type); + public abstract function build_query($type); /** * Gets the id of the last inserted row. - * - * @return mixed The id of the last inserted row - * @access public + * + * @return mixed The id of the last inserted row + * @access public */ - public abstract function get_insert_id(); - - /** + public abstract function get_insert_id(); + + /** * Gets column names for the specified table - * - * @param string $table Name of the table to get columns from + * + * @param string $table Name of the table to get columns from * @return array Array of column names - * @access public + * @access public */ - public abstract function list_columns($table); + public abstract function list_columns($table); /** * Executes a named query where parameters are passed as an associative array - * Example: - * <code> - * $result=$db->namedQuery("SELECT * FROM fairies where name = :name",array('name'=>'Tinkerbell')); - * </code> - * + * Example: + * <code> + * $result=$db->namedQuery("SELECT * FROM fairies where name = :name",array('name'=>'Tinkerbell')); + * </code> + * * @param string $query A named query * @param array $params Associative array of parameters * @return Result_Database Current drivers implementation of Result_Database - * @access public + * @access public */ - public function named_query($query, $params=array()) { - $bind = array(); - preg_match_all('#:(\w+)#is', $query, $matches,PREG_SET_ORDER); - foreach($matches as $match) - if(isset($params[$match[1]])){ - $query = preg_replace("#{$match[0]}#", '?', $query, 1); - $bind[] = $params[$match[1]]; - } - return $this->execute($query,$bind); - } + public function named_query($query, $params=array()) + { + $bind = array(); + preg_match_all('#:(\w+)#is', $query, $matches,PREG_SET_ORDER); + foreach($matches as $match) + { + if (isset($params[$match[1]])) + { + $query = preg_replace("#{$match[0]}#", '?', $query, 1); + $bind[] = $params[$match[1]]; + } + } + return $this->execute($query,$bind); + } /** * Returns an Expression_Database representation of the value. - * Values wrapped inside Expression_Database are not escaped in queries - * + * Values wrapped inside Expression_Database are not escaped in queries + * * @param mixed $value Value to be wrapped * @return Expression_Database Raw value that will not be escaped during query building - * @access public - * @static + * @access public + * @static */ - public static function expr($value){ - return new Expression_Database($value); - } - + public static function expr($value) + { + return new Expression_Database($value); + } + /** * Builds a query for specified connection. - * + * * @param string $type Query type. Available types: select,update,insert,delete,count * @param string $config Configuration name of the connection. - * Defaults to 'default'. + * Defaults to 'default'. * @return Query_Database Driver implementation of the Query_Database class. - * @access public - * @static + * @access public + * @static */ - public static function query($type,$config = 'default') { - return DB::instance($config)->build_query($type); - } + public static function query($type,$config = 'default') + { + return DB::instance($config)->build_query($type); + } /** * Gets the id of the last inserted row - * + * * @param string $config Configuration name of the connection. - * Defaults to 'default'. + * Defaults to 'default'. * @return mixed Id of the last inserted row - * @access public - * @static + * @access public + * @static */ - public static function insert_id($config = 'default') { - return DB::instance($config)->get_insert_id(); - } + public static function insert_id($config = 'default') + { + return DB::instance($config)->get_insert_id(); + } /** * Gets an instance of a connection to the database - * + * * @param string $config Configuration name of the connection. - * Defaults to 'default'. + * Defaults to 'default'. * @return DB Driver implementation of the DB class. - * @access public - * @static + * @access public + * @static */ - public static function instance($config='default'){ - if (!isset(DB::$_instances[$config])) { - $driver = Config::get("database.{$config}.driver"); - $driver="DB_{$driver}_Driver"; - DB::$_instances[$config] = new $driver($config); - } - return DB::$_instances[$config]; - } + public static function instance($config='default') + { + if (!isset(DB::$_instances[$config])) + { + $driver = Config::get("database.{$config}.driver"); + $driver = "DB_{$driver}_Driver"; + DB::$_instances[$config] = new $driver($config); + } + return DB::$_instances[$config]; + } -}
\ No newline at end of file +} |