From 9078e19961fa9e308f8d129904493700303bdcac Mon Sep 17 00:00:00 2001 From: Timothy Warren Date: Tue, 30 Oct 2012 16:14:57 +0000 Subject: [PATCH] Documenation update and more fat trimming --- classes/query_builder.php | 268 ++-- docs/classes/BadConnectionException.html | 4 +- docs/classes/BadDBDriverException.html | 4 +- docs/classes/DB_PDO.html | 15 +- docs/classes/DB_SQL.html | 4 +- docs/classes/DB_Util.html | 4 +- docs/classes/Firebird.html | 27 +- docs/classes/Firebird_Result.html | 4 +- docs/classes/Firebird_SQL.html | 4 +- docs/classes/Firebird_Util.html | 4 +- docs/classes/MySQL.html | 27 +- docs/classes/MySQL_SQL.html | 4 +- docs/classes/MySQL_Util.html | 4 +- docs/classes/ODBC.html | 27 +- docs/classes/ODBC_SQL.html | 4 +- docs/classes/ODBC_Util.html | 4 +- docs/classes/PgSQL.html | 27 +- docs/classes/PgSQL_SQL.html | 4 +- docs/classes/PgSQL_Util.html | 4 +- docs/classes/Query_Builder.html | 184 ++- docs/classes/Query_Parser.html | 4 +- docs/classes/SQLite.html | 27 +- docs/classes/SQLite_SQL.html | 4 +- docs/classes/SQLite_Util.html | 4 +- docs/deprecated.html | 4 +- docs/errors.html | 111 +- docs/graph_class.html | 4 +- docs/markers.html | 4 +- docs/namespaces/default.html | 4 +- docs/packages/.html | 4 +- docs/packages/Default.html | 4 +- docs/packages/Query.Drivers.html | 4 +- docs/packages/Query.Query.html | 4 +- docs/packages/Query.html | 4 +- docs/structure.xml | 1459 +++++++++++----------- tests/db_files/FB_TEST_DB.FDB | Bin 802816 -> 802816 bytes 36 files changed, 1194 insertions(+), 1078 deletions(-) diff --git a/classes/query_builder.php b/classes/query_builder.php index 29fbd27..f494a87 100644 --- a/classes/query_builder.php +++ b/classes/query_builder.php @@ -46,147 +46,74 @@ class Query_Builder { // ! SQL Clause Strings // -------------------------------------------------------------------------- - /** - * Compiled 'select' clause - * - * @var string - */ + // Compiled 'select' clause private $select_string; - /** - * Compiled 'from' clause - * - * @var string - */ + // Compiled 'from' clause private $from_string; - /** - * Compiled arguments for insert / update - * - * @var string - */ + // Compiled arguments for insert / update private $set_string; - /** - * Order by clause - * - * @var string - */ + // Order by clause private $order_string; - /** - * Group by clause - * - * @var string - */ + // Group by clause private $group_string; // -------------------------------------------------------------------------- // ! SQL Clause Arrays // -------------------------------------------------------------------------- - /** - * Keys for insert/update statement - * - * @var array - */ + // Keys for insert/update statement private $set_array_keys; - /** - * Key/val pairs for order by clause - * - * @var array - */ + // Key/val pairs for order by clause private $order_array; - /** - * Key/val pairs for group by clause - * - * @var array - */ + // Key/val pairs for group by clause private $group_array; // -------------------------------------------------------------------------- // ! Other Class vars // -------------------------------------------------------------------------- - /** - * Values to apply to prepared statements - * - * @var array - */ + // Values to apply to prepared statements private $values = array(); - /** - * Values to apply to where clauses in prepared statements - * - * @var array - */ + // Values to apply to where clauses in prepared statements private $where_values = array(); - /** - * Value for limit string - * - * @var int - */ + // Value for limit string private $limit; - /** - * Value for offset in limit string - * - * @var int - */ + // Value for offset in limit string private $offset; - /** - * Alias to $this->db->sql - * - * @var DB_PDO - */ + // Alias to $this->db->sql public $sql; - /** - * Database table prefix - * - * @var string - */ + // Database table prefix public $table_prefix = ''; - /** - * Query component order mapping - * for complex select queries - * - * Format: - * - * array( - * 'type' => 'where', - * 'conjunction' => ' AND ', - * 'string' => 'k=?' - * ) - * - * @var array - */ + // Query component order mapping + // for complex select queries + // + // Format: + // array( + // 'type' => 'where', + // 'conjunction' => ' AND ', + // 'string' => 'k=?' + // ) private $query_map; - /** - * Map for having clause - * - * @var array - */ + // Map for having clause private $having_map; - /** - * Convenience property for connection management - * - * @var string - */ + // Convenience property for connection management public $conn_name = ""; - /** - * List of sql queries executed - * - * @var array - */ + // List of sql queries executed public $queries; // -------------------------------------------------------------------------- @@ -274,14 +201,9 @@ class Query_Builder { try { // Create the database connection - if ( ! empty($params->user)) - { - $this->db = new $dbtype($dsn, $params->user, $params->pass); - } - else - { - $this->db = new $dbtype($dsn); - } + $this->db = ( ! empty($params->user)) + ? new $dbtype($dsn, $params->user, $params->pass) + : new $dbtype($dsn); } catch(Exception $e) { @@ -1336,12 +1258,10 @@ class Query_Builder { // delete class methods! foreach($this as $name => $var) { + $skip = array('db','sql','queries','table_prefix'); + // Skip properties that are needed for every query - if (in_array($name, array( - 'db', - 'sql', - 'queries', - ))) + if (in_array($name, $skip)) { continue; } @@ -1366,8 +1286,9 @@ class Query_Builder { /** * Executes the compiled query * - * @param string type - * @param string table + * @param string $type + * @param string $table + * @param bool $simple * @return mixed */ private function _run($type, $table, $simple=FALSE) @@ -1375,14 +1296,9 @@ class Query_Builder { $sql = $this->_compile($type, $table); $vals = array_merge($this->values, (array) $this->where_values); - if ($simple) - { - $res = $this->query($sql); - } - else - { - $res = $this->prepare_execute($sql, $vals); - } + $res = ($simple) + ? $this->query($sql) + : $this->prepare_execute($sql, $vals); $this->reset_query(); @@ -1391,23 +1307,6 @@ class Query_Builder { // -------------------------------------------------------------------------- - /** - * Auto-prefix table names - * - * @param string $table - * @return string - */ - private function prefix($table) - { - // If there isn't a prefix, just return - if (empty($this->table_prefix)) - { - return $table; - } - } - - // -------------------------------------------------------------------------- - /** * Calls a function further down the inheritence chain * @@ -1452,42 +1351,6 @@ class Query_Builder { // Replace the star with the selected fields $sql = str_replace('*', $this->select_string, $sql); } - - // Set the where string - if ( ! empty($this->query_map)) - { - foreach($this->query_map as $q) - { - $sql .= $q['conjunction'] . $q['string']; - } - } - - // Set the group_by string - if ( ! empty($this->group_string)) - { - $sql .= $this->group_string; - } - - // Set the having string - if ( ! empty($this->having_map)) - { - foreach($this->having_map as $h) - { - $sql .= $h['conjunction'] . $h['string']; - } - } - - // Set the order_by string - if ( ! empty($this->order_string)) - { - $sql .= $this->order_string; - } - - // Set the limit via the class variables - if (isset($this->limit) && is_numeric($this->limit)) - { - $sql = $this->sql->limit($sql, $this->limit, $this->offset); - } break; case "insert": @@ -1500,32 +1363,49 @@ class Query_Builder { case "update": $sql = "UPDATE {$table} SET {$this->set_string}"; - - // Set the where string - if ( ! empty($this->query_map)) - { - foreach($this->query_map as $q) - { - $sql .= $q['conjunction'] . $q['string']; - } - } break; case "delete": $sql = "DELETE FROM {$table}"; - - // Set the where string - if ( ! empty($this->query_map)) - { - foreach($this->query_map as $q) - { - $sql .= $q['conjunction'] . $q['string']; - } - } - break; } + // Set the where string + if ( ! empty($this->query_map)) + { + foreach($this->query_map as $q) + { + $sql .= $q['conjunction'] . $q['string']; + } + } + + // Set the group_by string + if ( ! empty($this->group_string)) + { + $sql .= $this->group_string; + } + + // Set the order_by string + if ( ! empty($this->order_string)) + { + $sql .= $this->order_string; + } + + // Set the limit via the class variables + if (isset($this->limit) && is_numeric($this->limit)) + { + $sql = $this->sql->limit($sql, $this->limit, $this->offset); + } + + // Set the having string + if ( ! empty($this->having_map)) + { + foreach($this->having_map as $h) + { + $sql .= $h['conjunction'] . $h['string']; + } + } + // Add the query to the list of executed queries $this->queries[] = $sql; diff --git a/docs/classes/BadConnectionException.html b/docs/classes/BadConnectionException.html index f7211c7..99024ec 100644 --- a/docs/classes/BadConnectionException.html +++ b/docs/classes/BadConnectionException.html @@ -32,7 +32,7 @@ Reports