TCriteria
extends TExpression
in package
Provides an interface for filtering criteria definition
Tags
Table of Contents
Constants
- AND_OPERATOR = 'AND '
- OR_OPERATOR = 'OR '
Properties
- $caseInsensitive : mixed
- $expressions : mixed
- $operators : mixed
- $properties : mixed
Methods
- __clone() : mixed
- When clonning criteria
- __construct() : mixed
- Constructor Method
- add() : mixed
- Adds a new Expression to the Criteria
- create() : mixed
- create criteria from array of filters
- dump() : A
- Returns the final expression
- getCaseInsensitive() : bool
- Return if case insensitive is turned on
- getPreparedVars() : mixed
- Return the prepared vars
- getProperty() : A
- Return a Criteria property
- isEmpty() : mixed
- Return if criteria is empty
- resetProperties() : mixed
- reset criteria properties
- setCaseInsensitive() : void
- Force case insensitive searches
- setProperties() : mixed
- Set properties form array
- setProperty() : mixed
- Define a Criteria property
Constants
AND_OPERATOR
public
mixed
AND_OPERATOR
= 'AND '
OR_OPERATOR
public
mixed
OR_OPERATOR
= 'OR '
Properties
$caseInsensitive
private
mixed
$caseInsensitive
$expressions
private
mixed
$expressions
$operators
private
mixed
$operators
$properties
private
mixed
$properties
Methods
__clone()
When clonning criteria
public
__clone() : mixed
__construct()
Constructor Method
public
__construct() : mixed
Tags
add()
Adds a new Expression to the Criteria
public
add( $expression[, $operator = self::AND_OPERATOR ]) : mixed
Parameters
Tags
create()
create criteria from array of filters
public
static create(mixed $simple_filters[, mixed $properties = null ]) : mixed
Parameters
- $simple_filters : mixed
- $properties : mixed = null
dump()
Returns the final expression
public
dump([ $prepared = FALSE ]) : A
Parameters
Tags
Return values
A —string containing the resulting expression
getCaseInsensitive()
Return if case insensitive is turned on
public
getCaseInsensitive() : bool
Return values
boolgetPreparedVars()
Return the prepared vars
public
getPreparedVars() : mixed
getProperty()
Return a Criteria property
public
getProperty( $property) : A
Parameters
Tags
Return values
A —String containing the property value
isEmpty()
Return if criteria is empty
public
isEmpty() : mixed
resetProperties()
reset criteria properties
public
resetProperties() : mixed
setCaseInsensitive()
Force case insensitive searches
public
setCaseInsensitive(bool $value) : void
Parameters
- $value : bool
setProperties()
Set properties form array
public
setProperties( $properties) : mixed
Parameters
setProperty()
Define a Criteria property
public
setProperty( $property, $value) : mixed