Class BetweenExpression
An expression object that represents a SQL BETWEEN snippet
Property Summary
Method Summary
-
__clone() public
Do a deep clone of this expression.
-
__construct() public
Constructor
-
_bindValue() protected
Registers a value in the placeholder generator and returns the generated placeholder
-
getField() public
Returns the field name
-
setField() public
Sets the field name
-
sql() public
Converts the expression to its string representation
-
traverse() public
Iterates over each part of the expression recursively for every level of the expressions tree and executes the $visitor callable passing as first parameter the instance of the expression currently being iterated.
Method Detail
__construct() ¶ public
__construct(mixed $field, mixed $from, mixed $to, string $type = null)Constructor
Parameters
-
mixed$field The field name to compare for values in between the range.
-
mixed$from The initial value of the range.
-
mixed$to The ending value in the comparison range.
-
string$type optional The data type name to bind the values with.
_bindValue() ¶ protected
_bindValue(mixed $value, Cake\Database\ValueBinder $generator, string $type): stringRegisters a value in the placeholder generator and returns the generated placeholder
Parameters
-
mixed$value The value to bind
-
Cake\Database\ValueBinder$generator The value binder to use
-
string$type The type of $value
Returns
stringgetField() ¶ public
getField(): string|Cake\Database\ExpressionInterfaceReturns the field name
Returns
string|Cake\Database\ExpressionInterfacesetField() ¶ public
setField(string $field): voidSets the field name
Parameters
-
string$field The field to compare with.
Returns
voidsql() ¶ public
sql(Cake\Database\ValueBinder $generator): stringConverts the expression to its string representation
Parameters
-
Cake\Database\ValueBinder$generator Placeholder generator object
Returns
stringtraverse() ¶ public
traverse(callable $callable): voidIterates over each part of the expression recursively for every level of the expressions tree and executes the $visitor callable passing as first parameter the instance of the expression currently being iterated.
Parameters
-
callable$callable
Returns
voidProperty Detail
$_field ¶ protected
The field name or expression to be used in the left hand side of the operator
Type
string