PHP Class Pop\Db\Sql\Predicate

Author: Nick Sagona, III ([email protected])
显示文件 Open project: nicksagona/PopPHP Class Usage Examples

Protected Properties

Property Type Description
$nested array Nested predicates
$predicates array Predicates array
$sql Pop\Db\Sql SQL object

Public Methods

Method Description
__construct ( Sql $sql ) : Predicate Constructor
__toString ( ) : string Predicate return string
between ( string $column, string $value1, string $value2, string $combine = 'AND' ) : Predicate Predicate for BETWEEN
equalTo ( string $column, string $value, string $combine = 'AND' ) : Predicate Predicate for =
getNest ( integer $i ) : mixed Get a nested predicate
greaterThan ( string $column, string $value, string $combine = 'AND' ) : Predicate Predicate for >
greaterThanOrEqualTo ( string $column, string $value, string $combine = 'AND' ) : Predicate Predicate for >=
hasNest ( integer $i = null ) : boolean Determine if it has a nested predicate branch
in ( string $column, mixed $values, string $combine = 'AND' ) : Predicate Predicate for IN
isNotNull ( string $column, string $combine = 'AND' ) : Predicate Predicate for IS NOT NULL
isNull ( string $column, string $combine = 'AND' ) : Predicate Predicate for IS NULL
lessThan ( string $column, string $value, string $combine = 'AND' ) : Predicate Predicate for <
lessThanOrEqualTo ( string $column, string $value, string $combine = 'AND' ) : Predicate Predicate for <=
like ( string $column, string $value, string $combine = 'AND' ) : Predicate Predicate for LIKE
nest ( ) : Predicate Add a nested predicate
notBetween ( string $column, string $value1, string $value2, string $combine = 'AND' ) : Predicate Predicate for NOT BETWEEN
notEqualTo ( string $column, string $value, string $combine = 'AND' ) : Predicate Predicate for !=
notIn ( string $column, mixed $values, string $combine = 'AND' ) : Predicate Predicate for NOT IN
notLike ( string $column, string $value, string $combine = 'AND' ) : Predicate Predicate for NOT LIKE
render ( integer $count = 1 ) : string Predicate render method

Method Details

__construct() public method

Instantiate the predicate collection object.
public __construct ( Sql $sql ) : Predicate
$sql Pop\Db\Sql
return Predicate

__toString() public method

Predicate return string
public __toString ( ) : string
return string

between() public method

Predicate for BETWEEN
public between ( string $column, string $value1, string $value2, string $combine = 'AND' ) : Predicate
$column string
$value1 string
$value2 string
$combine string
return Predicate

equalTo() public method

Predicate for =
public equalTo ( string $column, string $value, string $combine = 'AND' ) : Predicate
$column string
$value string
$combine string
return Predicate

getNest() public method

Get a nested predicate
public getNest ( integer $i ) : mixed
$i integer
return mixed

greaterThan() public method

Predicate for >
public greaterThan ( string $column, string $value, string $combine = 'AND' ) : Predicate
$column string
$value string
$combine string
return Predicate

greaterThanOrEqualTo() public method

Predicate for >=
public greaterThanOrEqualTo ( string $column, string $value, string $combine = 'AND' ) : Predicate
$column string
$value string
$combine string
return Predicate

hasNest() public method

Determine if it has a nested predicate branch
public hasNest ( integer $i = null ) : boolean
$i integer
return boolean

in() public method

Predicate for IN
public in ( string $column, mixed $values, string $combine = 'AND' ) : Predicate
$column string
$values mixed
$combine string
return Predicate

isNotNull() public method

Predicate for IS NOT NULL
public isNotNull ( string $column, string $combine = 'AND' ) : Predicate
$column string
$combine string
return Predicate

isNull() public method

Predicate for IS NULL
public isNull ( string $column, string $combine = 'AND' ) : Predicate
$column string
$combine string
return Predicate

lessThan() public method

Predicate for <
public lessThan ( string $column, string $value, string $combine = 'AND' ) : Predicate
$column string
$value string
$combine string
return Predicate

lessThanOrEqualTo() public method

Predicate for <=
public lessThanOrEqualTo ( string $column, string $value, string $combine = 'AND' ) : Predicate
$column string
$value string
$combine string
return Predicate

like() public method

Predicate for LIKE
public like ( string $column, string $value, string $combine = 'AND' ) : Predicate
$column string
$value string
$combine string
return Predicate

nest() public method

Add a nested predicate
public nest ( ) : Predicate
return Predicate

notBetween() public method

Predicate for NOT BETWEEN
public notBetween ( string $column, string $value1, string $value2, string $combine = 'AND' ) : Predicate
$column string
$value1 string
$value2 string
$combine string
return Predicate

notEqualTo() public method

Predicate for !=
public notEqualTo ( string $column, string $value, string $combine = 'AND' ) : Predicate
$column string
$value string
$combine string
return Predicate

notIn() public method

Predicate for NOT IN
public notIn ( string $column, mixed $values, string $combine = 'AND' ) : Predicate
$column string
$values mixed
$combine string
return Predicate

notLike() public method

Predicate for NOT LIKE
public notLike ( string $column, string $value, string $combine = 'AND' ) : Predicate
$column string
$value string
$combine string
return Predicate

render() public method

Predicate render method
public render ( integer $count = 1 ) : string
$count integer
return string

Property Details

$nested protected_oe property

Nested predicates
protected array $nested
return array

$predicates protected_oe property

Predicates array
protected array $predicates
return array

$sql protected_oe property

SQL object
protected Sql,Pop\Db $sql
return Pop\Db\Sql