Class BetweenExpression
An expression object that represents a SQL BETWEEN snippet
Properties summary
- $_field protected
string|array|\Cake\Database\ExpressionInterfaceThe field name or expression to be used in the left hand side of the operator
- $_from protected
mixedThe first value in the expression
- $_to protected
mixedThe second value in the expression
- $_type protected
mixedThe data type for the from and to arguments
Method Summary
- _bindValue() protected
Registers a value in the placeholder generator and returns the generated placeholder
- _castToExpression() protected
Conditionally converts the passed value to an ExpressionInterface object if the type class implements the ExpressionTypeInterface. Otherwise, returns the value unmodified.
- _requiresToExpressionCasting() protected
Returns an array with the types that require values to be casted to expressions, out of the list of type names passed as parameter.
- 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
__clone() public
__clone()
Do a deep clone of this expression.
__construct() public
__construct(mixed $field, mixed $from, mixed $to, mixed $type)
Constructor
Parameters
-
string|\Cake\Database\ExpressionInterface$field The field name to compare for values inbetween the range.
-
mixed$from The initial value of the range.
-
mixed$to The ending value in the comparison range.
-
string|null$type optional The data type name to bind the values with.
_bindValue() protected
_bindValue(mixed $value, mixed $generator, mixed $type)
Registers 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
stringgenerated placeholder
_castToExpression() protected
_castToExpression(mixed $value, ?string $type)
Conditionally converts the passed value to an ExpressionInterface object if the type class implements the ExpressionTypeInterface. Otherwise, returns the value unmodified.
Parameters
-
mixed$value The value to converto to ExpressionInterface
-
string|null$type optional The type name
Returns
mixed_requiresToExpressionCasting() protected
_requiresToExpressionCasting(array $types)
Returns an array with the types that require values to be casted to expressions, out of the list of type names passed as parameter.
Parameters
-
array$types List of type names
Returns
arraygetField() public
getField()
Returns the field name
Returns
string|array|\Cake\Database\ExpressionInterfacesetField() public
setField(mixed $field)
Sets the field name
Parameters
-
string|array|\Cake\Database\ExpressionInterface$field The field to compare with.
sql() public
sql(\Cake\Database\ValueBinder $generator)
Converts the expression to its string representation
Parameters
-
\Cake\Database\ValueBinder$generator Placeholder generator object
Returns
stringtraverse() public
traverse(\Closure $visitor)
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.
Parameters
-
\Closure$visitor The callable to apply to all nodes.
Returns
$thisProperty Detail
$_field protected
The field name or expression to be used in the left hand side of the operator
Type
string|array|\Cake\Database\ExpressionInterface$_from protected
The first value in the expression
Type
mixed$_to protected
The second value in the expression
Type
mixed$_type protected
The data type for the from and to arguments
Type
mixed
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.0/class-Cake.Database.Expression.BetweenExpression.html