Interface defining the Query Builder class

package Query
subpackage Query

 Methods

Retreive the number of rows in the selected table

count_all(string $table) : int

Parameters

$table

string

Returns

int

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

count_all_results(string $table = '') : int

Parameters

$table

string

Returns

int

Deletes data from a table

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

Parameters

$table

string

$where

mixed

Returns

Adds the 'distinct' keyword to a query

distinct() : \Query_Builder_Interface
fluent This method is part of a fluent interface and will return the same instance

Returns

\Query_Builder_Interface

Shows the query plan for the query

explain() : \Query_Builder_Interface
fluent This method is part of a fluent interface and will return the same instance

Returns

\Query_Builder_Interface

Specify the database table to select from

from(string $tblname) : \Query_Builder_Interface
fluent This method is part of a fluent interface and will return the same instance

Parameters

$tblname

string

Returns

\Query_Builder_Interface

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

get(mixed $table = '', int $limit = FALSE, int $offset = FALSE) : \PDOStatement

Parameters

$table

$limit

int

$offset

int

Returns

Returns the generated 'delete' sql query

get_compiled_delete(string $table = "", bool $reset = TRUE) : string

Parameters

$table

string

$reset

bool

Returns

string

Returns the generated 'insert' sql query

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

Parameters

$table

string

$reset

bool

Returns

string

Returns the generated 'select' sql query

get_compiled_select(string $table = '', bool $reset = TRUE) : string

Parameters

$table

string

$reset

bool

Returns

string

Returns the generated 'update' sql query

get_compiled_update(string $table = '', bool $reset = TRUE) : string

Parameters

$table

string

$reset

bool

Returns

string

Convience method for get() with a where clause

get_where(string $table, array $where = array(), int $limit = FALSE, int $offset = FALSE) : \PDOStatement

Parameters

$table

string

$where

array

$limit

int

$offset

int

Returns

Group the results by the selected field(s)

group_by(mixed $field) : \Query_Builder_Interface
fluent This method is part of a fluent interface and will return the same instance

Parameters

$field

mixed

Returns

\Query_Builder_Interface

Ends a query group

group_end() : \Query_Builder_Interface
fluent This method is part of a fluent interface and will return the same instance

Returns

\Query_Builder_Interface

Adds a paren to the current query for query grouping

group_start() : \Query_Builder_Interface
fluent This method is part of a fluent interface and will return the same instance

Returns

\Query_Builder_Interface

Generates a 'Having' clause

having(mixed $key, mixed $val = array()) : \Query_Builder_Interface
fluent This method is part of a fluent interface and will return the same instance

Parameters

$key

mixed

$val

mixed

Returns

\Query_Builder_Interface

Creates an insert clause, and executes it

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

Parameters

$table

string

$data

mixed

Returns

Creates and executes a batch insertion query

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

Parameters

$table

string

$data

array

Returns

Creates a join phrase in a compiled query

join(string $table, string $condition, string $type = '') : \Query_Builder_Interface
fluent This method is part of a fluent interface and will return the same instance

Parameters

$table

string

$condition

string

$type

string

Returns

\Query_Builder_Interface

Creates a Like clause in the sql statement

like(string $field, mixed $val, string $pos = 'both') : \Query_Builder_Interface
fluent This method is part of a fluent interface and will return the same instance

Parameters

$field

string

$val

mixed

$pos

string

Returns

\Query_Builder_Interface

Set a limit on the current sql statement

limit(int $limit, int $offset = FALSE) : string

Parameters

$limit

int

$offset

int

Returns

string

Generates a NOT LIKE clause

not_like(string $field, mixed $val, string $pos = 'both') : \Query_Builder_Interface
fluent This method is part of a fluent interface and will return the same instance

Parameters

$field

string

$val

mixed

$pos

string

Returns

\Query_Builder_Interface

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

or_group_start() : \Query_Builder_Interface
fluent This method is part of a fluent interface and will return the same instance

Returns

\Query_Builder_Interface

Generates a 'Having' clause prefixed with 'OR'

or_having(mixed $key, mixed $val = array()) : \Query_Builder_Interface
fluent This method is part of a fluent interface and will return the same instance

Parameters

$key

mixed

$val

mixed

Returns

\Query_Builder_Interface

Generates an OR Like clause

or_like(string $field, mixed $val, string $pos = 'both') : \Query_Builder_Interface
fluent This method is part of a fluent interface and will return the same instance

Parameters

$field

string

$val

mixed

$pos

string

Returns

\Query_Builder_Interface

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

or_not_group_start() : \Query_Builder_Interface
fluent This method is part of a fluent interface and will return the same instance

Returns

\Query_Builder_Interface

Generates a OR NOT LIKE clause

or_not_like(string $field, mixed $val, string $pos = 'both') : \Query_Builder_Interface
fluent This method is part of a fluent interface and will return the same instance

Parameters

$field

string

$val

mixed

$pos

string

Returns

\Query_Builder_Interface

Where clause prefixed with "OR"

or_where(string $key, mixed $val = array()) : \Query_Builder_Interface
fluent This method is part of a fluent interface and will return the same instance

Parameters

$key

string

$val

mixed

Returns

\Query_Builder_Interface

Where in statement prefixed with "or"

or_where_in(string $field, mixed $val = array()) : \Query_Builder_Interface
fluent This method is part of a fluent interface and will return the same instance

Parameters

$field

string

$val

mixed

Returns

\Query_Builder_Interface

OR WHERE NOT IN (FOO) clause

or_where_not_in(string $field, mixed $val = array()) : \Query_Builder_Interface
fluent This method is part of a fluent interface and will return the same instance

Parameters

$field

string

$val

mixed

Returns

\Query_Builder_Interface

Order the results by the selected field(s)

order_by(string $field, string $type = "") : \Query_Builder_Interface
fluent This method is part of a fluent interface and will return the same instance

Parameters

$field

string

$type

string

Returns

\Query_Builder_Interface

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

reset_query() : void

Specifies rows to select in a query

select(string $fields) : \Query_Builder_Interface
fluent This method is part of a fluent interface and will return the same instance

Parameters

$fields

string

Returns

\Query_Builder_Interface

Selects the average value of a field from a query

select_avg(string $field, string $as = FALSE) : \Query_Builder_Interface
fluent This method is part of a fluent interface and will return the same instance

Parameters

$field

string

$as

string

Returns

\Query_Builder_Interface

Selects the maximum value of a field from a query

select_max(string $field, string $as = FALSE) : \Query_Builder_Interface
fluent This method is part of a fluent interface and will return the same instance

Parameters

$field

string

$as

string

Returns

\Query_Builder_Interface

Selects the minimum value of a field from a query

select_min(string $field, string $as = FALSE) : \Query_Builder_Interface
fluent This method is part of a fluent interface and will return the same instance

Parameters

$field

string

$as

string

Returns

\Query_Builder_Interface

Selects the sum of a field from a query

select_sum(string $field, string $as = FALSE) : \Query_Builder_Interface
fluent This method is part of a fluent interface and will return the same instance

Parameters

$field

string

$as

string

Returns

\Query_Builder_Interface

Sets values for inserts / updates / deletes

set(mixed $key, mixed $val = NULL) : \Query_Builder_Interface
fluent This method is part of a fluent interface and will return the same instance

Parameters

$key

mixed

$val

mixed

Returns

\Query_Builder_Interface

Creates an update clause, and executes it

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

Parameters

$table

string

$data

mixed

Returns

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

where(mixed $key, mixed $val = array(), bool $escape = NULL) : \Query_Builder_Interface
fluent This method is part of a fluent interface and will return the same instance

Parameters

$key

mixed

$val

mixed

$escape

bool

Returns

\Query_Builder_Interface

Where clause with 'IN' statement

where_in(mixed $field, mixed $val = array()) : \Query_Builder_Interface
fluent This method is part of a fluent interface and will return the same instance

Parameters

$field

mixed

$val

mixed

Returns

\Query_Builder_Interface

WHERE NOT IN (FOO) clause

where_not_in(string $field, mixed $val = array()) : \Query_Builder_Interface
fluent This method is part of a fluent interface and will return the same instance

Parameters

$field

string

$val

mixed

Returns

\Query_Builder_Interface