TFilter
extends TExpression
in package
Provides an interface to define filters to be used inside a criteria
Tags
Table of Contents
Constants
- AND_OPERATOR = 'AND '
- OR_OPERATOR = 'OR '
Properties
- $caseInsensitive : mixed
- $operator : mixed
- $paramCounter : mixed
- $preparedVars : mixed
- $value : mixed
- $value2 : mixed
- $variable : mixed
Methods
- __construct() : mixed
- Class Constructor
- dump() : A
- Return the filter as a string expression
- getCaseInsensitive() : bool
- Return if case insensitive is turned ON
- getPreparedVars() : mixed
- Return the prepared vars
- setCaseInsensitive() : void
- Force case insensitive searches
- getRandomParameter() : mixed
- Returns a random parameter
- replacePseudoPreparedVars() : mixed
- Replace pseudo prepared vars
- transform() : Transformed
- Transform the value according to its PHP type before send it to the database
Constants
AND_OPERATOR
public
mixed
AND_OPERATOR
= 'AND '
OR_OPERATOR
public
mixed
OR_OPERATOR
= 'OR '
Properties
$caseInsensitive
private
mixed
$caseInsensitive
$operator
private
mixed
$operator
$paramCounter
private
static mixed
$paramCounter
$preparedVars
private
mixed
$preparedVars
$value
private
mixed
$value
$value2
private
mixed
$value2
$variable
private
mixed
$variable
Methods
__construct()
Class Constructor
public
__construct(mixed $variable, mixed $operator, mixed $value[, mixed $value2 = NULL ]) : mixed
Parameters
- $variable : mixed
-
= variable
- $operator : mixed
-
= operator (>, <, =, BETWEEN)
- $value : mixed
-
= value to be compared
- $value2 : mixed = NULL
-
= second value to be compared (between)
dump()
Return the filter as a string expression
public
dump([mixed $prepared = FALSE ]) : A
Parameters
- $prepared : mixed = FALSE
Return values
A —string containing the filter
getCaseInsensitive()
Return if case insensitive is turned ON
public
getCaseInsensitive() : bool
Return values
boolgetPreparedVars()
Return the prepared vars
public
getPreparedVars() : mixed
setCaseInsensitive()
Force case insensitive searches
public
setCaseInsensitive(bool $value) : void
Parameters
- $value : bool
getRandomParameter()
Returns a random parameter
private
getRandomParameter() : mixed
replacePseudoPreparedVars()
Replace pseudo prepared vars
private
replacePseudoPreparedVars(mixed $value) : mixed
Parameters
- $value : mixed
transform()
Transform the value according to its PHP type before send it to the database
private
transform(mixed $value[, mixed $prepared = FALSE ]) : Transformed
Parameters
- $value : mixed
-
Value to be transformed
- $prepared : mixed = FALSE
-
If the value will be prepared
Return values
Transformed —Value