Query
\
Query
Driver
Util
SQL

\QueryQuery_Builder

Convenience class for creating sql queries - also the class that instantiates the specific db driver

Summary

Methods
Properties
Constants
__construct()
__destruct()
__call()
select()
select_max()
select_min()
select_avg()
select_sum()
distinct()
explain()
from()
like()
or_like()
not_like()
or_not_like()
having()
or_having()
where()
or_where()
where_in()
or_where_in()
where_not_in()
or_where_not_in()
set()
join()
group_by()
order_by()
limit()
group_start()
or_group_start()
or_not_group_start()
group_end()
get()
get_where()
count_all()
count_all_results()
insert()
insert_batch()
update()
delete()
get_compiled_select()
get_compiled_insert()
get_compiled_update()
get_compiled_delete()
reset_query()
$conn_name
$queries
$db
$util
$sql
KEY
VALUE
BOTH
_mixed_set()
_select()
_get_compile()
_like()
_having()
_where()
_where_string()
_where_in()
_run()
_append_map()
_append_query()
_compile_type()
_compile()
$select_string
$from_string
$set_string
$order_string
$group_string
$set_array_keys
$order_array
$group_array
$values
$where_values
$limit
$offset
$query_map
$having_map
$explain
$parser
N/A
No private methods found
$string_vars
$array_vars
N/A

Constants

KEY

KEY

VALUE

VALUE

BOTH

BOTH

Properties

$conn_name

$conn_name : string

Convenience property for connection management

Type

string

$queries

$queries : array

List of queries executed

Type

array

$util

$util : \Query\Driver\Abstract_Util

Alias to driver util class

Type

\Query\Driver\Abstract_Util

$sql

$sql : \Query\Driver\SQL_Interface

Alias to driver sql class

Type

\Query\Driver\SQL_Interface

$select_string

$select_string : string

Compiled 'select' clause

Type

string

$from_string

$from_string : string

Compiled 'from' clause

Type

string

$set_string

$set_string : string

Compiled arguments for insert / update

Type

string

$order_string

$order_string : string

Order by clause

Type

string

$group_string

$group_string : string

Group by clause

Type

string

$set_array_keys

$set_array_keys : array

Keys for insert/update statement

Type

array

$order_array

$order_array : array

Key/val pairs for order by clause

Type

array

$group_array

$group_array : array

Key/val pairs for group by clause

Type

array

$values

$values : array

Values to apply to prepared statements

Type

array

$where_values

$where_values : array

Values to apply to where clauses in prepared statements

Type

array

$limit

$limit : string

Value for limit string

Type

string

$offset

$offset : int

Value for offset in limit string

Type

int

$query_map

$query_map : array

Query component order mapping for complex select queries

Format: array(

'type' => 'where',
'conjunction' => ' AND ',
'string' => 'k=?'

)

Type

array

$having_map

$having_map : array

Map for having clause

Type

array

$explain

$explain : bool

Whether to do only an explain on the query

Type

bool

$string_vars

$string_vars : array

String class values to be reset

Type

array

$array_vars

$array_vars : array

Array class variables to be reset

Type

array

Methods

__destruct()

__destruct()

Destructor

__call()

__call(string $name, array $params) : mixed

Calls a function further down the inheritence chain

Parameters

string $name
array $params

Throws

\BadMethodCallException

Returns

mixed

select()

select(string $fields) : \Query\Query_Builder

Specifies rows to select in a query

Parameters

string $fields

Returns

\Query\Query_Builder

select_max()

select_max(string $field, string|FALSE $as) : \Query\Query_Builder

Selects the maximum value of a field from a query

Parameters

string $field
string|FALSE $as

Returns

\Query\Query_Builder

select_min()

select_min(string $field, string|bool $as) : \Query\Query_Builder

Selects the minimum value of a field from a query

Parameters

string $field
string|bool $as

Returns

\Query\Query_Builder

select_avg()

select_avg(string $field, string|bool $as) : \Query\Query_Builder

Selects the average value of a field from a query

Parameters

string $field
string|bool $as

Returns

\Query\Query_Builder

select_sum()

select_sum(string $field, string|bool $as) : \Query\Query_Builder

Selects the sum of a field from a query

Parameters

string $field
string|bool $as

Returns

\Query\Query_Builder

distinct()

distinct() : \Query\Query_Builder

Adds the 'distinct' keyword to a query

Returns

\Query\Query_Builder

explain()

explain() : \Query\Query_Builder

Tell the database to give you the query plan instead of result set

Returns

\Query\Query_Builder

from()

from(string $tblname) : \Query\Query_Builder

Specify the database table to select from

Parameters

string $tblname

Returns

\Query\Query_Builder

like()

like(string $field, mixed $val, string $pos) : \Query\Query_Builder

Creates a Like clause in the sql statement

Parameters

string $field
mixed $val
string $pos

Returns

\Query\Query_Builder

or_like()

or_like(string $field, mixed $val, string $pos) : \Query\Query_Builder

Generates an OR Like clause

Parameters

string $field
mixed $val
string $pos

Returns

\Query\Query_Builder

not_like()

not_like(string $field, mixed $val, string $pos) : \Query\Query_Builder

Generates a NOT LIKE clause

Parameters

string $field
mixed $val
string $pos

Returns

\Query\Query_Builder

or_not_like()

or_not_like(string $field, mixed $val, string $pos) : \Query\Query_Builder

Generates a OR NOT LIKE clause

Parameters

string $field
mixed $val
string $pos

Returns

\Query\Query_Builder

having()

having(mixed $key, mixed $val) : \Query\Query_Builder

Generates a 'Having' clause

Parameters

mixed $key
mixed $val

Returns

\Query\Query_Builder

or_having()

or_having(mixed $key, mixed $val) : \Query\Query_Builder

Generates a 'Having' clause prefixed with 'OR'

Parameters

mixed $key
mixed $val

Returns

\Query\Query_Builder

where()

where(mixed $key, mixed $val, mixed $escape) : \Query\Query_Builder

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

Parameters

mixed $key
mixed $val
mixed $escape

Returns

\Query\Query_Builder

or_where()

or_where(string $key, mixed $val) : \Query\Query_Builder

Where clause prefixed with "OR"

Parameters

string $key
mixed $val

Returns

\Query\Query_Builder

where_in()

where_in(mixed $field, mixed $val) : \Query\Query_Builder

Where clause with 'IN' statement

Parameters

mixed $field
mixed $val

Returns

\Query\Query_Builder

or_where_in()

or_where_in(string $field, mixed $val) : \Query\Query_Builder

Where in statement prefixed with "or"

Parameters

string $field
mixed $val

Returns

\Query\Query_Builder

where_not_in()

where_not_in(string $field, mixed $val) : \Query\Query_Builder

WHERE NOT IN (FOO) clause

Parameters

string $field
mixed $val

Returns

\Query\Query_Builder

or_where_not_in()

or_where_not_in(string $field, mixed $val) : \Query\Query_Builder

OR WHERE NOT IN (FOO) clause

Parameters

string $field
mixed $val

Returns

\Query\Query_Builder

set()

set(mixed $key, mixed $val) : \Query\Query_Builder

Sets values for inserts / updates / deletes

Parameters

mixed $key
mixed $val

Returns

\Query\Query_Builder

join()

join(string $table, string $condition, string $type) : \Query\Query_Builder

Creates a join phrase in a compiled query

Parameters

string $table
string $condition
string $type

Returns

\Query\Query_Builder

group_by()

group_by(mixed $field) : \Query\Query_Builder

Group the results by the selected field(s)

Parameters

mixed $field

Returns

\Query\Query_Builder

order_by()

order_by(string $field, string $type) : \Query\Query_Builder

Order the results by the selected field(s)

Parameters

string $field
string $type

Returns

\Query\Query_Builder

limit()

limit(int $limit, int|bool $offset) : \Query\Query_Builder

Set a limit on the current sql statement

Parameters

int $limit
int|bool $offset

Returns

\Query\Query_Builder

group_start()

group_start() : \Query\Query_Builder

Adds a paren to the current query for query grouping

Returns

\Query\Query_Builder

or_group_start()

or_group_start() : \Query\Query_Builder

Adds a paren to the current query for query grouping, prefixed with 'OR'

Returns

\Query\Query_Builder

or_not_group_start()

or_not_group_start() : \Query\Query_Builder

Adds a paren to the current query for query grouping, prefixed with 'OR NOT'

Returns

\Query\Query_Builder

get()

get(mixed $table, int|bool $limit, int|bool $offset) : \PDOStatement

Select and retrieve all records from the current table, and/or execute current compiled query

Parameters

mixed $table
int|bool $limit
int|bool $offset

Returns

\PDOStatement

get_where()

get_where(string $table, array $where, int|bool $limit, int|bool $offset) : \PDOStatement

Convenience method for get() with a where clause

Parameters

string $table
array $where
int|bool $limit
int|bool $offset

Returns

\PDOStatement

count_all()

count_all(string $table) : int

Retreive the number of rows in the selected table

Parameters

string $table

Returns

int

count_all_results()

count_all_results(string $table) : int

Retrieve the number of results for the generated query - used in place of the get() method

Parameters

string $table

Returns

int

insert()

insert(string $table, mixed $data) : \PDOStatement

Creates an insert clause, and executes it

Parameters

string $table
mixed $data

Returns

\PDOStatement

insert_batch()

insert_batch(string $table, array $data) : \PDOStatement

Creates and executes a batch insertion query

Parameters

string $table
array $data

Returns

\PDOStatement

update()

update(string $table, mixed $data) : \PDOStatement

Creates an update clause, and executes it

Parameters

string $table
mixed $data

Returns

\PDOStatement

delete()

delete(string $table, mixed $where) : \PDOStatement

Deletes data from a table

Parameters

string $table
mixed $where

Returns

\PDOStatement

get_compiled_select()

get_compiled_select(string $table, bool $reset) : string

Returns the generated 'select' sql query

Parameters

string $table
bool $reset

Returns

string

get_compiled_insert()

get_compiled_insert(string $table, bool $reset) : string

Returns the generated 'insert' sql query

Parameters

string $table
bool $reset

Returns

string

get_compiled_update()

get_compiled_update(string $table, bool $reset) : string

Returns the generated 'update' sql query

Parameters

string $table
bool $reset

Returns

string

get_compiled_delete()

get_compiled_delete(string $table, bool $reset) : string

Returns the generated 'delete' sql query

Parameters

string $table
bool $reset

Returns

string

reset_query()

reset_query() : void

Clear out the class variables, so the next query can be run

_mixed_set()

_mixed_set(array $var, mixed $key, mixed $val, int $val_type) : array

Set values in the class, with either an array or key value pair

Parameters

array $var
mixed $key
mixed $val
int $val_type

Returns

array

_select()

_select(string $field, string|bool $as) : string

Method to simplify select_ methods

Parameters

string $field
string|bool $as

Returns

string

_get_compile()

_get_compile(string $type, string $table, bool $reset) : string

Helper function for returning sql strings

Parameters

string $type
string $table
bool $reset

Returns

string

_like()

_like(string $field, mixed $val, string $pos, string $like, string $conj) : \Query\Query_Builder

Simplify 'like' methods

Parameters

string $field
mixed $val
string $pos
string $like
string $conj

Returns

\Query\Query_Builder

_having()

_having(mixed $key, mixed $val, string $conj) : \Query\Query_Builder

Simplify building having clauses

Parameters

mixed $key
mixed $val
string $conj

Returns

\Query\Query_Builder

_where()

_where(mixed $key, mixed $val) : array

Do all the repeditive stuff for where/having type methods

Parameters

mixed $key
mixed $val

Returns

array

_where_string()

_where_string(mixed $key, mixed $val, string $defaultConj) : \Query\Query_Builder

Simplify generating where string

Parameters

mixed $key
mixed $val
string $defaultConj

Returns

\Query\Query_Builder

_where_in()

_where_in(mixed $key, mixed $val, string $in, string $conj) : \Query\Query_Builder

Simplify where_in methods

Parameters

mixed $key
mixed $val
string $in
  • The (not) in fragment
string $conj
  • The where in conjunction

Returns

\Query\Query_Builder

_run()

_run(string $type, string $table, string $sql, array|null $vals) : \PDOStatement

Executes the compiled query

Parameters

string $type
string $table
string $sql
array|null $vals

Returns

\PDOStatement

_append_map()

_append_map(string $conjunction, string $string, string $type) : void

Add an additional set of mapping pairs to a internal map

Parameters

string $conjunction
string $string
string $type

_append_query()

_append_query(array $vals, string $sql, string $total_time) : void

Convert the prepared statement into readable sql

Parameters

array $vals
string $sql
string $total_time

_compile_type()

_compile_type(string $type, string $table) : string

Sub-method for generating sql strings

Parameters

string $type
string $table

Returns

string

_compile()

_compile(string $type, string $table) : \Query\$string

String together the sql statements for sending to the db

Parameters

string $type
string $table

Returns

\Query\$string