aviat/Query
1
1
Fork 0
Code Issues 1 Pull Requests Releases 2 Activity

Update lots of comments

Browse Source
This commit is contained in:
Timothy Warren 2015-11-10 20:58:32 -05:00
parent 57b0e5e2a3
commit 2613a1c8a4
25 changed files with 71 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/Query/AbstractDriver.php
View File

@ -6,7 +6,7 @@
*
* @package Query
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @copyright Copyright (c) 2012 - 2015
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
*/
@ -41,13 +41,13 @@ abstract class AbstractDriver extends \PDO implements DriverInterface {
/**
* Reference to sql class
* @var SQL_Interface
* @var SQLInterface
*/
protected $sql;
/**
* Reference to util class
* @var Abstract_Util
* @var AbstractUtil
*/
protected $util;

10
src/Query/AbstractQueryBuilder.php
View File

@ -6,7 +6,7 @@
*
* @package Query
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @copyright Copyright (c) 2012 - 2015
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
*/
@ -163,19 +163,19 @@ abstract class AbstractQueryBuilder {
/**
* Query parser class instance
* @var Query_Parser
* @var QueryParser
*/
public $parser;
/**
* Alias to driver util class
* @var \Query\Driver\Abstract_Util
* @var \Query\Driver\AbstractUtil
*/
public $util;
/**
* Alias to driver sql class
* @var \Query\Driver\SQL_Interface
* @var \Query\Driver\SQLInterface
*/
public $sql;
@ -376,7 +376,7 @@ abstract class AbstractQueryBuilder {
$last_item = end($this->query_map);
// Determine the correct conjunction
$conjunctionList = array_pluck($this->query_map, 'conjunction');
$conjunctionList = array_column($this->query_map, 'conjunction');
if (empty($this->query_map) || ( ! regex_in_array($conjunctionList, "/^ ?\n?WHERE/i")))
{
$conj = "\nWHERE ";

2
src/Query/AbstractSQL.php
View File

@ -5,7 +5,7 @@
* Free Query Builder / Database Abstraction Layer
*
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @copyright Copyright (c) 2012 - 2015
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
* @package Query

4
src/Query/AbstractUtil.php
View File

@ -6,7 +6,7 @@
*
* @package Query
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @copyright Copyright (c) 2012 - 2015
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
*/
@ -35,7 +35,7 @@ abstract class AbstractUtil {
/**
* Save a reference to the connection object for later use
*
* @param Driver_Interface $conn
* @param DriverInterface $conn
*/
public function __construct(DriverInterface $conn)
{

2
src/Query/BadDBDriverException.php
View File

@ -6,7 +6,7 @@
*
* @package Query
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @copyright Copyright (c) 2012 - 2015
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
*/

6
src/Query/ConnectionManager.php
View File

@ -6,7 +6,7 @@
*
* @package Query
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @copyright Copyright (c) 2012 - 2015
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
*/
@ -83,7 +83,7 @@ final class ConnectionManager {
* Return a connection manager instance
*
* @staticvar null $instance
* @return Connection_Manager
* @return ConnectionManager
*/
public static function get_instance()
{
@ -98,7 +98,7 @@ final class ConnectionManager {
* Returns the connection specified by the name given
*
* @param string|array|object $name
* @return Query_Builder
* @return QueryBuilder
* @throws \InvalidArgumentException
*/
public function get_connection($name = '')

4
src/Query/DriverInterface.php
View File

@ -6,7 +6,7 @@
*
* @package Query
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @copyright Copyright (c) 2012 - 2015
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
*/
@ -270,4 +270,4 @@ interface DriverInterface {
*/
public function insert_batch($table, $data=array());
}
// End of driver_interface.php
// End of driver_interface.php

2
src/Query/Drivers/Firebird/Driver.php
View File

@ -6,7 +6,7 @@
*
* @package Query
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @copyright Copyright (c) 2012 - 2015
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
*/

4
src/Query/Drivers/Firebird/Result.php
View File

@ -6,7 +6,7 @@
*
* @package Query
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @copyright Copyright (c) 2012 - 2015
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
*/
@ -48,7 +48,7 @@ class Result extends \PDOStatement {
/**
* Reference to the db drive to de-duplicate error functions
*
* @var \Query\Drivers\Firebird\Driver
* @var Driver
*/
private $db;

2
src/Query/Drivers/Firebird/SQL.php
View File

@ -6,7 +6,7 @@
*
* @package Query
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @copyright Copyright (c) 2012 - 2015
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
*/

2
src/Query/Drivers/Firebird/Util.php
View File

@ -6,7 +6,7 @@
*
* @package Query
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @copyright Copyright (c) 2012 - 2015
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
*/

2
src/Query/Drivers/Mysql/Driver.php
View File

@ -6,7 +6,7 @@
*
* @package Query
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @copyright Copyright (c) 2012 - 2015
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
*/

2
src/Query/Drivers/Mysql/SQL.php
View File

@ -6,7 +6,7 @@
*
* @package Query
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @copyright Copyright (c) 2012 - 2015
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
*/

4
src/Query/Drivers/Mysql/Util.php
View File

@ -6,7 +6,7 @@
*
* @package Query
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @copyright Copyright (c) 2012 - 2015
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
*/
@ -118,4 +118,4 @@ class Util extends \Query\AbstractUtil {
return $output_sql;
}
}
// End of mysql_util.php
// End of mysql_util.php

2
src/Query/Drivers/Pgsql/Driver.php
View File

@ -6,7 +6,7 @@
*
* @package Query
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @copyright Copyright (c) 2012 - 2015
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
*/

2
src/Query/Drivers/Pgsql/SQL.php
View File

@ -5,7 +5,7 @@
* Free Query Builder / Database Abstraction Layer
*
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @copyright Copyright (c) 2012 - 2015
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
*/

4
src/Query/Drivers/Pgsql/Util.php
View File

@ -6,7 +6,7 @@
*
* @package Query
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @copyright Copyright (c) 2012 - 2015
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
*/
@ -96,4 +96,4 @@ class Util extends \Query\AbstractUtil {
return $output_sql;
}
}
// End of pgsql_util.php
// End of pgsql_util.php

2
src/Query/Drivers/Sqlite/Driver.php
View File

@ -6,7 +6,7 @@
*
* @package Query
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @copyright Copyright (c) 2012 - 2015
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
*/

2
src/Query/Drivers/Sqlite/SQL.php
View File

@ -6,7 +6,7 @@
*
* @package Query
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @copyright Copyright (c) 2012 - 2015
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
*/

2
src/Query/Drivers/Sqlite/Util.php
View File

@ -6,7 +6,7 @@
*
* @package Query
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @copyright Copyright (c) 2012 - 2015
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
*/

2
src/Query/QueryBuilder.php
View File

@ -6,7 +6,7 @@
*
* @package Query
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @copyright Copyright (c) 2012 - 2015
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
*/

64
src/Query/QueryBuilderInterface.php
View File

@ -6,7 +6,7 @@
*
* @package Query
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @copyright Copyright (c) 2012 - 2015
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
*/
@ -19,7 +19,7 @@ namespace Query;
* Interface defining the Query Builder class
*
* @package Query
* @subpackage Query_Builder
* @subpackage QueryBuilder
*/
interface QueryBuilderInterface {
@ -31,7 +31,7 @@ interface QueryBuilderInterface {
* Specifies rows to select in a query
*
* @param string $fields
* @return Query_Builder
* @return QueryBuilder
*/
public function select($fields);
@ -42,7 +42,7 @@ interface QueryBuilderInterface {
*
* @param string $field
* @param string|bool $as
* @return Query_Builder
* @return QueryBuilder
*/
public function select_max($field, $as=FALSE);
@ -53,7 +53,7 @@ interface QueryBuilderInterface {
*
* @param string $field
* @param string|bool $as
* @return Query_Builder
* @return QueryBuilder
*/
public function select_min($field, $as=FALSE);
@ -64,7 +64,7 @@ interface QueryBuilderInterface {
*
* @param string $field
* @param string|bool $as
* @return Query_Builder
* @return QueryBuilder
*/
public function select_avg($field, $as=FALSE);
@ -75,7 +75,7 @@ interface QueryBuilderInterface {
*
* @param string $field
* @param string|bool $as
* @return Query_Builder
* @return QueryBuilder
*/
public function select_sum($field, $as=FALSE);
@ -84,7 +84,7 @@ interface QueryBuilderInterface {
/**
* Adds the 'distinct' keyword to a query
*
* @return Query_Builder
* @return QueryBuilder
*/
public function distinct();
@ -93,7 +93,7 @@ interface QueryBuilderInterface {
/**
* Shows the query plan for the query
*
* @return Query_Builder
* @return QueryBuilder
*/
public function explain();
@ -103,7 +103,7 @@ interface QueryBuilderInterface {
* Specify the database table to select from
*
* @param string $tblname
* @return Query_Builder
* @return QueryBuilder
*/
public function from($tblname);
@ -117,7 +117,7 @@ interface QueryBuilderInterface {
* @param string $field
* @param mixed $val
* @param string $pos
* @return Query_Builder
* @return QueryBuilder
*/
public function like($field, $val, $pos='both');
@ -129,7 +129,7 @@ interface QueryBuilderInterface {
* @param string $field
* @param mixed $val
* @param string $pos
* @return Query_Builder
* @return QueryBuilder
*/
public function or_like($field, $val, $pos='both');
@ -141,7 +141,7 @@ interface QueryBuilderInterface {
* @param string $field
* @param mixed $val
* @param string $pos
* @return Query_Builder
* @return QueryBuilder
*/
public function not_like($field, $val, $pos='both');
@ -153,7 +153,7 @@ interface QueryBuilderInterface {
* @param string $field
* @param mixed $val
* @param string $pos
* @return Query_Builder
* @return QueryBuilder
*/
public function or_not_like($field, $val, $pos='both');
@ -166,7 +166,7 @@ interface QueryBuilderInterface {
*
* @param mixed $key
* @param mixed $val
* @return Query_Builder
* @return QueryBuilder
*/
public function having($key, $val=array());
@ -177,7 +177,7 @@ interface QueryBuilderInterface {
*
* @param mixed $key
* @param mixed $val
* @return Query_Builder
* @return QueryBuilder
*/
public function or_having($key, $val=array());
@ -193,7 +193,7 @@ interface QueryBuilderInterface {
* @param mixed $key
* @param mixed $val
* @param bool $escape
* @return Query_Builder
* @return QueryBuilder
*/
public function where($key, $val=array(), $escape = NULL);
@ -204,7 +204,7 @@ interface QueryBuilderInterface {
*
* @param string $key
* @param mixed $val
* @return Query_Builder
* @return QueryBuilder
*/
public function or_where($key, $val=array());
@ -215,7 +215,7 @@ interface QueryBuilderInterface {
*
* @param mixed $field
* @param mixed $val
* @return Query_Builder
* @return QueryBuilder
*/
public function where_in($field, $val=array());
@ -226,7 +226,7 @@ interface QueryBuilderInterface {
*
* @param string $field
* @param mixed $val
* @return Query_Builder
* @return QueryBuilder
*/
public function or_where_in($field, $val=array());
@ -237,7 +237,7 @@ interface QueryBuilderInterface {
*
* @param string $field
* @param mixed $val
* @return Query_Builder
* @return QueryBuilder
*/
public function where_not_in($field, $val=array());
@ -248,7 +248,7 @@ interface QueryBuilderInterface {
*
* @param string $field
* @param mixed $val
* @return Query_Builder
* @return QueryBuilder
*/
public function or_where_not_in($field, $val=array());
@ -261,7 +261,7 @@ interface QueryBuilderInterface {
*
* @param mixed $key
* @param mixed $val
* @return Query_Builder
* @return QueryBuilder
*/
public function set($key, $val = NULL);
@ -273,7 +273,7 @@ interface QueryBuilderInterface {
* @param string $table
* @param string $condition
* @param string $type
* @return Query_Builder
* @return QueryBuilder
*/
public function join($table, $condition, $type='');
@ -283,7 +283,7 @@ interface QueryBuilderInterface {
* Group the results by the selected field(s)
*
* @param mixed $field
* @return Query_Builder
* @return QueryBuilder
*/
public function group_by($field);
@ -294,7 +294,7 @@ interface QueryBuilderInterface {
*
* @param string $field
* @param string $type
* @return Query_Builder
* @return QueryBuilder
*/
public function order_by($field, $type="");
@ -305,7 +305,7 @@ interface QueryBuilderInterface {
*
* @param int $limit
* @param int|bool $offset
* @return Query_Builder
* @return QueryBuilder
*/
public function limit($limit, $offset=FALSE);
@ -316,7 +316,7 @@ interface QueryBuilderInterface {
/**
* Adds a paren to the current query for query grouping
*
* @return Query_Builder
* @return QueryBuilder
*/
public function group_start();
@ -326,7 +326,7 @@ interface QueryBuilderInterface {
* Adds a paren to the current query for query grouping,
* prefixed with 'OR'
*
* @return Query_Builder
* @return QueryBuilder
*/
public function or_group_start();
@ -336,7 +336,7 @@ interface QueryBuilderInterface {
* Adds a paren to the current query for query grouping,
* prefixed with 'OR NOT'
*
* @return Query_Builder
* @return QueryBuilder
*/
public function or_not_group_start();
@ -345,7 +345,7 @@ interface QueryBuilderInterface {
/**
* Ends a query group
*
* @return Query_Builder
* @return QueryBuilder
*/
public function group_end();
@ -500,4 +500,4 @@ interface QueryBuilderInterface {
public function reset_query();
}
// End of query_builder_interface.php
// End of QueryBuilder_interface.php

2
src/Query/QueryParser.php
View File

@ -6,7 +6,7 @@
*
* @package Query
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @copyright Copyright (c) 2012 - 2015
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
*/

2
src/Query/SQLInterface.php
View File

@ -5,7 +5,7 @@
* Free Query Builder / Database Abstraction Layer
*
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @copyright Copyright (c) 2012 - 2015
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
* @package Query

6
src/common.php
View File

@ -7,7 +7,7 @@
* @package Query
* @subpackage Core
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @copyright Copyright (c) 2012 - 2015
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
*/
@ -132,7 +132,7 @@ if ( ! function_exists('array_zipper'))
// --------------------------------------------------------------------------
if ( ! function_exists('array_pluck'))
if ( ! function_exists('array_column'))
{
/**
* Get an array out of an multi-dimensional array based on a common
@ -142,7 +142,7 @@ if ( ! function_exists('array_pluck'))
* @param string $key
* @return array
*/
function array_pluck(Array $array, $key)
function array_column(Array $array, $key)
{
$output = array();