Source of file QueryBuilderInterface.php
Size: 12,435 Bytes - Last Modified: 2015-11-10T09:59:33-05:00
../src/Query/QueryBuilderInterface.php
| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504 | <?php/** * Query * * Free Query Builder / Database Abstraction Layer * * @package Query * @author Timothy J. Warren * @copyright Copyright (c) 2012 - 2014 * @link https://github.com/aviat4ion/Query * @license http://philsturgeon.co.uk/code/dbad-license */// --------------------------------------------------------------------------namespace Query; /** * Interface defining the Query Builder class * * @package Query * @subpackage Query_Builder */interface QueryBuilderInterface { // -------------------------------------------------------------------------- // ! Select Queries // -------------------------------------------------------------------------- /** * Specifies rows to select in a query * * @param string $fields * @return Query_Builder */public function select($fields); // -------------------------------------------------------------------------- /** * Selects the maximum value of a field from a query * * @param string $field * @param string|bool $as * @return Query_Builder */public function select_max($field, $as=FALSE); // -------------------------------------------------------------------------- /** * Selects the minimum value of a field from a query * * @param string $field * @param string|bool $as * @return Query_Builder */public function select_min($field, $as=FALSE); // -------------------------------------------------------------------------- /** * Selects the average value of a field from a query * * @param string $field * @param string|bool $as * @return Query_Builder */public function select_avg($field, $as=FALSE); // -------------------------------------------------------------------------- /** * Selects the sum of a field from a query * * @param string $field * @param string|bool $as * @return Query_Builder */public function select_sum($field, $as=FALSE); // -------------------------------------------------------------------------- /** * Adds the 'distinct' keyword to a query * * @return Query_Builder */public function distinct(); // -------------------------------------------------------------------------- /** * Shows the query plan for the query * * @return Query_Builder */public function explain(); // -------------------------------------------------------------------------- /** * Specify the database table to select from * * @param string $tblname * @return Query_Builder */public function from($tblname); // -------------------------------------------------------------------------- // ! 'Like' methods // -------------------------------------------------------------------------- /** * Creates a Like clause in the sql statement * * @param string $field * @param mixed $val * @param string $pos * @return Query_Builder */public function like($field, $val, $pos='both'); // -------------------------------------------------------------------------- /** * Generates an OR Like clause * * @param string $field * @param mixed $val * @param string $pos * @return Query_Builder */public function or_like($field, $val, $pos='both'); // -------------------------------------------------------------------------- /** * Generates a NOT LIKE clause * * @param string $field * @param mixed $val * @param string $pos * @return Query_Builder */public function not_like($field, $val, $pos='both'); // -------------------------------------------------------------------------- /** * Generates a OR NOT LIKE clause * * @param string $field * @param mixed $val * @param string $pos * @return Query_Builder */public function or_not_like($field, $val, $pos='both'); // -------------------------------------------------------------------------- // ! Having methods // -------------------------------------------------------------------------- /** * Generates a 'Having' clause * * @param mixed $key * @param mixed $val * @return Query_Builder */public function having($key, $val=array()); // -------------------------------------------------------------------------- /** * Generates a 'Having' clause prefixed with 'OR' * * @param mixed $key * @param mixed $val * @return Query_Builder */public function or_having($key, $val=array()); // -------------------------------------------------------------------------- // ! 'Where' methods // -------------------------------------------------------------------------- /** * Specify condition(s) in the where clause of a query * Note: this function works with key / value, or a * passed array with key / value pairs * * @param mixed $key * @param mixed $val * @param bool $escape * @return Query_Builder */public function where($key, $val=array(), $escape = NULL); // -------------------------------------------------------------------------- /** * Where clause prefixed with "OR" * * @param string $key * @param mixed $val * @return Query_Builder */public function or_where($key, $val=array()); // -------------------------------------------------------------------------- /** * Where clause with 'IN' statement * * @param mixed $field * @param mixed $val * @return Query_Builder */public function where_in($field, $val=array()); // -------------------------------------------------------------------------- /** * Where in statement prefixed with "or" * * @param string $field * @param mixed $val * @return Query_Builder */public function or_where_in($field, $val=array()); // -------------------------------------------------------------------------- /** * WHERE NOT IN (FOO) clause * * @param string $field * @param mixed $val * @return Query_Builder */public function where_not_in($field, $val=array()); // -------------------------------------------------------------------------- /** * OR WHERE NOT IN (FOO) clause * * @param string $field * @param mixed $val * @return Query_Builder */public function or_where_not_in($field, $val=array()); // -------------------------------------------------------------------------- // ! Other Query Modifier methods // -------------------------------------------------------------------------- /** * Sets values for inserts / updates / deletes * * @param mixed $key * @param mixed $val * @return Query_Builder */public function set($key, $val = NULL); // -------------------------------------------------------------------------- /** * Creates a join phrase in a compiled query * * @param string $table * @param string $condition * @param string $type * @return Query_Builder */public function join($table, $condition, $type=''); // -------------------------------------------------------------------------- /** * Group the results by the selected field(s) * * @param mixed $field * @return Query_Builder */public function group_by($field); // -------------------------------------------------------------------------- /** * Order the results by the selected field(s) * * @param string $field * @param string $type * @return Query_Builder */public function order_by($field, $type=""); // -------------------------------------------------------------------------- /** * Set a limit on the current sql statement * * @param int $limit * @param int|bool $offset * @return Query_Builder */public function limit($limit, $offset=FALSE); // -------------------------------------------------------------------------- // ! Query Grouping Methods // -------------------------------------------------------------------------- /** * Adds a paren to the current query for query grouping * * @return Query_Builder */public function group_start(); // -------------------------------------------------------------------------- /** * Adds a paren to the current query for query grouping, * prefixed with 'OR' * * @return Query_Builder */public function or_group_start(); // -------------------------------------------------------------------------- /** * Adds a paren to the current query for query grouping, * prefixed with 'OR NOT' * * @return Query_Builder */public function or_not_group_start(); // -------------------------------------------------------------------------- /** * Ends a query group * * @return Query_Builder */public function group_end(); // -------------------------------------------------------------------------- // ! Query execution methods // -------------------------------------------------------------------------- /** * Select and retrieve all records from the current table, and/or * execute current compiled query * * @param $table * @param int|bool $limit * @param int|bool $offset * @return \PDOStatement */public function get($table='', $limit=FALSE, $offset=FALSE); // -------------------------------------------------------------------------- /** * Convience method for get() with a where clause * * @param string $table * @param array $where * @param int|bool $limit * @param int|bool $offset * @return \PDOStatement */public function get_where($table, $where=array(), $limit=FALSE, $offset=FALSE); // -------------------------------------------------------------------------- /** * Retrieve the number of rows in the selected table * * @param string $table * @return int */public function count_all($table); // -------------------------------------------------------------------------- /** * Retrieve the number of results for the generated query - used * in place of the get() method * * @param string $table * @return int */public function count_all_results($table=''); // -------------------------------------------------------------------------- /** * Creates an insert clause, and executes it * * @param string $table * @param mixed $data * @return \PDOStatement */public function insert($table, $data=array()); // -------------------------------------------------------------------------- /** * Creates and executes a batch insertion query * * @param string $table * @param array $data * @return \PDOStatement|null */public function insert_batch($table, $data=array()); // -------------------------------------------------------------------------- /** * Creates an update clause, and executes it * * @param string $table * @param mixed $data * @return \PDOStatement */public function update($table, $data=array()); // -------------------------------------------------------------------------- /** * Deletes data from a table * * @param string $table * @param mixed $where * @return \PDOStatement */public function delete($table, $where=''); // -------------------------------------------------------------------------- // ! SQL Returning Methods // -------------------------------------------------------------------------- /** * Returns the generated 'select' sql query * * @param string $table * @param bool $reset * @return string */public function get_compiled_select($table='', $reset=TRUE); // -------------------------------------------------------------------------- /** * Returns the generated 'insert' sql query * * @param string $table * @param bool $reset * @return string */public function get_compiled_insert($table, $reset=TRUE); // -------------------------------------------------------------------------- /** * Returns the generated 'update' sql query * * @param string $table * @param bool $reset * @return string */public function get_compiled_update($table='', $reset=TRUE); // -------------------------------------------------------------------------- /** * Returns the generated 'delete' sql query * * @param string $table * @param bool $reset * @return string */public function get_compiled_delete($table="", $reset=TRUE); // -------------------------------------------------------------------------- // ! Miscellaneous Methods // -------------------------------------------------------------------------- /** * Clear out the class variables, so the next query can be run * * @return void */public function reset_query(); }// End of query_builder_interface.php |