• Home
• SqlBuilder

PHP Class SqlBuilder, recess

User: Alexandr Date: 29.09.10 ファイルを表示 Open project: KrisJordan/recess Class Usage Examples

Protected Properties

Property	Type	Description
$assignments
$conditions		* UPDATE & DELETE
$conditionsUsed
$distinct
$groupBy
$joins
$limit
$offset
$orderBy
$select		* SELECT
$selectAs
$table		* INSERT
$useAssignmentsAsConditions
$usingAliases

Public Methods

Method	Description
assign ( string $column, mixed $value ) : SqlBuilder	Assign a value to a column. Used with inserts and updates.
between ( string $column, numeric $small, numeric $big ) : SqlBuilder	Shortcut alias for SqlBuilder->lessThan($column,$big)->greaterThan($column,$small)
delete ( ) : string	Build a DELETE SQL string from SqlBuilder's state.
distinct ( ) : SqlBuilder	Add a DISTINCT clause to SELECT SQL.
equal ( string $column, mixed $value ) : SqlBuilder	Equality expression for WHERE clause of update, delete, or select statements.
from ( string $table ) : SqlBuilder	Alias to specify which table is being used.
getCriteria ( )
getPdoArguments ( ) : array	Return the collection of PDO named parameters and values to be applied to a parameterized PDO statement.
getTable ( )
greaterThan ( string $column, numeric $value ) : SqlBuilder	Greater than expression for WHERE clause of update, delete, or select statements.
greaterThanOrEqualTo ( string $column, numeric $value ) : SqlBuilder	Greater than or equal to expression for WHERE clause of update, delete, or select statements.
groupBy ( string $clause ) : SqlBuilder	Add an GROUP BY expression to sql string. Example: ->groupBy('name')
in ( string $column, array $value ) : SqlBuilder	IN to expression for WHERE clause of update, delete, or select statements.
innerJoin ( string $table, string $tablePrimaryKey, string $fromTableForeignKey ) : SqlBuilder	Inner join expression for SELECT SQL statement.
insert ( ) : string	Build an INSERT SQL string from SqlBuilder's state.
into ( string $table ) : SqlBuilder	Alias for table (insert into)
isNotNull ( string $column ) : SqlBuilder	IS NOT NULL expression for WHERE clause of update, delete, or select statements
isNull ( string $column ) : SqlBuilder	IS NULL expression for WHERE clause of update, delete, or select statements
leftOuterJoin ( string $table, string $tablePrimaryKey, string $fromTableForeignKey ) : SqlBuilder	Left outer join expression for SELECT SQL statement.
lessThan ( string $column, numeric $value ) : SqlBuilder	Less than expression for WHERE clause of update, delete, or select statements.
lessThanOrEqualTo ( string $column, numeric $value ) : SqlBuilder	Less than or equal to expression for WHERE clause of update, delete, or select statements.
like ( string $column, string $value ) : SqlBuilder	LIKE expression for WHERE clause of update, delete, or select statements, does not include wildcards.
limit ( integer $size ) : SqlBuilder	LIMIT results to some number of records.
notEqual ( string $column, mixed $value ) : SqlBuilder	Inequality than expression for WHERE clause of update, delete, or select statements.
notLike ( string $column, string $value ) : SqlBuilder	NOT LIKE expression for WHERE clause of update, delete, or select statements, does not include wildcards.
offset ( integer $offset ) : SqlBuilder	When used in conjunction with limit($size), offset specifies which row the results will begin at.
orderBy ( string $clause ) : SqlBuilder	Add an ORDER BY expression to sql string. Example: ->orderBy('name ASC')
range ( integer $start, integer $finish ) : SqlBuilder	Shortcut alias to ->limit($finish - $start)->offset($start);
select ( ) : string	Build a SELECT SQL string from SqlBuilder's state.
selectAs ( string $select, string $as ) : SqlBuilder	Add additional field to select statement which is aliased using the AS parameter.
table ( string $table ) : SqlBuilder	Set the table of focus on a sql statement.
update ( ) : string	Build an UPDATE SQL string from SqlBuilder's state.
useAssignmentsAsConditions ( boolean $bool ) : SqlBuilder	Handy shortcut which allows assignments to be used as conditions in a select statement.

Protected Methods

Method	Description
addCondition ( string $column, mixed $value, string $operator ) : SqlBuilder	Add a condition to the SqlBuilder statement. Additional logic here to prepend a table name and also keep track of which columns have already been assigned conditions to ensure we do not use two identical named parameters in PDO.
cleansedAssignmentsAsConditions ( ) : array	Method for when using assignments as conditions. This purges assignments which have null values.
deleteSanityCheck ( )	Safety check used with delete.
escapeWithTicks ( $string )
groupByHelper ( )
insertSanityCheck ( )	Safety check used with insert to ensure only a table and assignments were applied.
join ( string $leftOrRight, string $innerOrOuter, string $table, string $tablePrimaryKey, string $fromTableForeignKey ) : SqlBuilder	Generic join expression to be added to a SELECT SQL statement.
joinHelper ( )
orderByHelper ( )
rangeHelper ( )
selectSanityCheck ( )	Safety check used when creating a SELECT statement.
tableAsPrefix ( ) : string	Helper method which returns the current table even when it is aliased due to joins between the same table.
updateSanityCheck ( )	Safety check used with update.
whereHelper ( )	* HELPER METHODS

Method Details

Property Details