Overview

Namespaces

  • Ark
    • Database

Classes

  • Connection
  • Model
  • ModelFactory
  • QueryBuilder

Interfaces

  • Exception
  • Overview
  • Namespace
  • Class

Class QueryBuilder

Database query builder

Namespace: Ark\Database
Located at QueryBuilder.php
Methods summary
public
# __construct( Ark\Database\Connection $db )

Constructor

Constructor

Parameters

$db
Database connection
protected
# matchAlias( $entry )
protected
# splitParts( $parts )
public Ark\Database\QueryBuilder
# reset( )

Reset builder

Reset builder

Returns

Ark\Database\QueryBuilder
public Ark\Database\QueryBuilder
# prepare( )

Prepare PDO statement

Prepare PDO statement

Returns

Ark\Database\QueryBuilder
public Ark\Database\QueryBuilder
# bindParam( )

Returns

Ark\Database\QueryBuilder

See

http://php.net/manual/en/pdostatement.bindparam.php
public Ark\Database\QueryBuilder
# bindValue( )

Returns

Ark\Database\QueryBuilder

See

http://php.net/manual/en/pdostatement.bindvalue.php
public Ark\Database\QueryBuilder
# bindValues( array $values )

Bind values

Bind values

Parameters

$values

Returns

Ark\Database\QueryBuilder
public Ark\Database\QueryBuilder
# mergeParams( array $params )

Merge params

Merge params

Parameters

$params

Returns

Ark\Database\QueryBuilder
public Ark\Database\QueryBuilder
# select( string|array $fields = '*' )

SELECT statement example: select('contact.*, user.email) select(array('contact.*', 'user.email'))

SELECT statement example: select('contact.*, user.email) select(array('contact.*', 'user.email'))

Parameters

$fields

Returns

Ark\Database\QueryBuilder
public Ark\Database\QueryBuilder
# distinct( )

DISTINCT statement

DISTINCT statement

Returns

Ark\Database\QueryBuilder
public Ark\Database\QueryBuilder
# from( string|array $tables )

FROM statement example: from('contact, user AS U') from(array('contact', 'user AS U'))

FROM statement example: from('contact, user AS U') from(array('contact', 'user AS U'))

Parameters

$tables

Returns

Ark\Database\QueryBuilder
public string
# buildConditions( string|array $conditions )

Build condition SQL

Build condition SQL

Parameters

$conditions

Returns

string
public Ark\Database\QueryBuilder
# where( string|array $conditions, array $params = array() )

WHERE statement

WHERE statement

Parameters

$conditions
$params

Returns

Ark\Database\QueryBuilder
public Ark\Database\QueryBuilder
# orderBy( string|array $fields )

ORDER BY statement example: orderBy('id DESC') orderBy('firstname, lastname DESC')

ORDER BY statement example: orderBy('id DESC') orderBy('firstname, lastname DESC')

Parameters

$fields

Returns

Ark\Database\QueryBuilder
public Ark\Database\QueryBuilder
# limit( integer $limit, integer $offset = null )

LIMIT statement

LIMIT statement

Parameters

$limit
$offset

Returns

Ark\Database\QueryBuilder
public Ark\Database\QueryBuilder
# offset( integer $offset )

OFFSET statement

OFFSET statement

Parameters

$offset

Returns

Ark\Database\QueryBuilder
protected Ark\Database\QueryBuilder
# anyJoin( string $type, string $table, string|array $conditions = '', array $params = array() )
  • JOIN statement
  • JOIN statement

Parameters

$type
LEFT JOIN|RIGHT JOIN...
$table
$conditions
$params

Returns

Ark\Database\QueryBuilder
public Ark\Database\QueryBuilder
# join( string $table, string|array $conditions = '', array $params = array() )

JOIN statement

JOIN statement

Parameters

$table
$conditions
$params

Returns

Ark\Database\QueryBuilder
public Ark\Database\QueryBuilder
# leftJoin( string $table, string|array $conditions = '', array $params = array() )

LEFT JOIN statement

LEFT JOIN statement

Parameters

$table
$conditions
$params

Returns

Ark\Database\QueryBuilder
public Ark\Database\QueryBuilder
# rightJoin( string $table, string|array $condtions = '', array $params = array() )

RIGHT JOIN statement

RIGHT JOIN statement

Parameters

$table
$condtions
$conditions
$params

Returns

Ark\Database\QueryBuilder
public Ark\Database\QueryBuilder
# groupBy( string|array $fields )

GROUP BY statement

GROUP BY statement

Parameters

$fields

Returns

Ark\Database\QueryBuilder
public Ark\Database\QueryBuilder
# having( string|array $conditions, array $params = array() )

HAVING statement

HAVING statement

Parameters

$conditions
$params

Returns

Ark\Database\QueryBuilder
public Ark\Database\QueryBuilder
# union( string $sql )

UNION statement

UNION statement

Parameters

$sql

Returns

Ark\Database\QueryBuilder
public string
# buildQuery( array $query = null )

Build query SQL

Build query SQL

Parameters

$query
use $this->query if not specified

Returns

string
public Ark\Database\QueryBuilder
# setSql( string $sql )

Set SQL for this command

Set SQL for this command

Parameters

$sql

Returns

Ark\Database\QueryBuilder
public string
# getSql( )

Get SQL for this command

Get SQL for this command

Returns

string
protected
# beginQuery( )

Prepare statement before query

Prepare statement before query
public PDOStatement
# query( array $params = array() )

Query Statement cursor should be closed after fetching data($statement->closeCursor)

Query Statement cursor should be closed after fetching data($statement->closeCursor)

Parameters

$params

Returns

PDOStatement
public array
# queryAll( array $params = array() )

Get query result as array

Get query result as array

Parameters

$params

Returns

array
public array
# queryRow( array $params = array() )

Get first row of result

Get first row of result

Parameters

$params

Returns

array
public array
# queryColumn( array $params = array() )

Get first column of result set

Get first column of result set

Parameters

$params

Returns

array
public string
# queryValue( array $params = array() )

Get first column of first row of result set

Get first column of first row of result set

Parameters

$params

Returns

string
public integer|boolean
# execute( array $params = array() )

Execute statement and return rows affected

Execute statement and return rows affected

Parameters

$params

Returns

integer|boolean
public last
# insert( string $table, array $values )

Insert data

Insert data

Parameters

$table
$values

Returns

last
insert id, false on error
public integer
# update( string $table, string|array $values, string|array $conditions = '', array $params = array() )

Update table

Update table

Parameters

$table
$values
$conditions
$params

Returns

integer
Rows affected, false on error
public integer
# delete( string $table, array $conditions = '', string|array $params = array(), array $params,… )

Delete

Delete

Parameters

$table
$conditions
$values
$params
$conditions
$params,…

Returns

integer
Rows affected, false on error
Properties summary
protected $db
#
protected $statement
#
protected array $params
# array()
protected array $positionParams
# array()
protected array $query
# array()
protected $sql
#
API documentation generated by ApiGen