This expression represents SQL fragments that are used for comparing one tuple to another, one tuple to a set of other tuples or one tuple to an expression
string|array|\Cake\Database\ExpressionInterfaceThe field name or expression to be used in the left hand side of the operator
boolWhether or not the value in this expression is a traversable
stringThe operator used for comparing field and value
arrayThe type to be used for casting the value to a database representation
mixedThe value to be used in the right hand side of the operation
\Cake\Database\ExpressionInterface[]A cached list of ExpressionInterface objects that were found in the value for this expression.
Registers a value in the placeholder generator and returns the generated placeholder
Conditionally converts the passed value to an ExpressionInterface object if the type class implements the ExpressionTypeInterface. Otherwise, returns the value unmodified.
Returns an array with the original $values in the first position and all ExpressionInterface objects that could be found in the second position.
Converts a traversable value into a set of placeholders generated by $generator and separated by ,
Returns an array with the types that require values to be casted to expressions, out of the list of type names passed as parameter.
Returns a template and a placeholder for the value after registering it with the placeholder $generator
Returns a string with the values as placeholders in a string to be used for the SQL version of this expression
Conditionally executes the callback for the passed value if it is an ExpressionInterface
Traverses the tree of expressions stored in this object, visiting first expressions in the left hand side and then the rest.
__clone()
Create a deep clone.
Clones the field and value if they are expression objects.
__construct(mixed $fields, mixed $values, array $types, string $conjunction)
Constructor
string|array|\Cake\Database\ExpressionInterface $fields the fields to use to form a tuple
array|\Cake\Database\ExpressionInterface $values the values to use to form a tuple
array $types optional the types names to use for casting each of the values, only one type per position in the value array in needed
string $conjunction optional the operator used for comparing field and value
_bindValue(mixed $value, \Cake\Database\ValueBinder $generator, ?string $type)
Registers a value in the placeholder generator and returns the generated placeholder
mixed $value The value to bind
\Cake\Database\ValueBinder $generator The value binder to use
string|null $type optional The type of $value
stringgenerated placeholder
_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.
mixed $value The value to converto to ExpressionInterface
string|null $type optional The type name
mixed_collectExpressions(mixed $values)
Returns an array with the original $values in the first position and all ExpressionInterface objects that could be found in the second position.
iterable|\Cake\Database\ExpressionInterface $values The rows to insert
array_flattenValue(iterable $value, \Cake\Database\ValueBinder $generator, ?string $type)
Converts a traversable value into a set of placeholders generated by $generator and separated by ,
iterable $value the value to flatten
\Cake\Database\ValueBinder $generator The value binder to use
string|null $type optional the type to cast values to
string_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.
array $types List of type names
array_stringExpression(\Cake\Database\ValueBinder $generator)
Returns a template and a placeholder for the value after registering it with the placeholder $generator
\Cake\Database\ValueBinder $generator The value binder to use.
arrayFirst position containing the template and the second a placeholder
_stringifyValues(\Cake\Database\ValueBinder $generator)
Returns a string with the values as placeholders in a string to be used for the SQL version of this expression
\Cake\Database\ValueBinder $generator The value binder to convert expressions with.
string_traverseValue(mixed $value, \Closure $callable)
Conditionally executes the callback for the passed value if it is an ExpressionInterface
mixed $value The value to traverse
\Closure $callable The callable to use when traversing
getField()
Returns the field name
string|array|\Cake\Database\ExpressionInterfacegetOperator()
Returns the operator used for comparison
stringgetValue()
Returns the value used for comparison
mixedisMulti()
Determines if each of the values in this expressions is a tuple in itself
boolsetField(mixed $field)
Sets the field name
string|array|\Cake\Database\ExpressionInterface $field The field to compare with.
setOperator(string $operator)
Sets the operator to use for the comparison
string $operator The operator to be used for the comparison.
setValue(mixed $value)
Sets the value
mixed $value The value to compare
sql(\Cake\Database\ValueBinder $generator)
Convert the expression into a SQL fragment.
\Cake\Database\ValueBinder $generator Placeholder generator object
stringtraverse(\Closure $visitor)
Traverses the tree of expressions stored in this object, visiting first expressions in the left hand side and then the rest.
Callback function receives as its only argument an instance of an ExpressionInterface
\Closure $visitor The callable to apply to sub-expressions
$thisThe field name or expression to be used in the left hand side of the operator
string|array|\Cake\Database\ExpressionInterfaceWhether or not the value in this expression is a traversable
boolThe operator used for comparing field and value
stringThe type to be used for casting the value to a database representation
arrayThe value to be used in the right hand side of the operation
mixedA cached list of ExpressionInterface objects that were found in the value for this expression.
\Cake\Database\ExpressionInterface[]
© 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.1/class-Cake.Database.Expression.TupleComparison.html