Class TupleComparison
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
Property Summary
-
$_field protected
stringCake\Database\ExpressionInterfaceThe field name or expression to be used in the left hand side of the operator
-
$_isMultiple protected
boolWhether or not the value in this expression is a traversable
-
$_operator protected
stringThe operator used for comparing field and value
-
$_type protected
arrayThe type to be used for casting the value to a database representation
-
$_value protected
mixedThe value to be used in the right hand side of the operation
-
$_valueExpressions protected
Cake\Database\ExpressionInterface[]A cached list of ExpressionInterface objects that were found in the value for this expression.
Method Summary
-
__clone() public
Create a deep clone.
-
__construct() public
Constructor
-
_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.
-
_collectExpressions() protected
Returns an array with the original $values in the first position and all ExpressionInterface objects that could be found in the second position.
-
_flattenValue() protected
Converts a traversable value into a set of placeholders generated by $generator and separated by
, -
_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.
-
_stringExpression() protected
Returns a template and a placeholder for the value after registering it with the placeholder $generator
-
_stringifyValues() protected
Returns a string with the values as placeholders in a string to be used for the SQL version of this expression
-
_traverseValue() protected
Conditionally executes the callback for the passed value if it is an ExpressionInterface
-
getField() public
Returns the field name
-
getOperator() public
Returns the operator used for comparison
-
getType() public
Returns the type to be used for casting the value to a database representation
-
getValue() public
Returns the value used for comparison
-
isMulti() public
Determines if each of the values in this expressions is a tuple in itself
-
setField() public
Sets the field name
-
setOperator() public
Sets the operator to use for the comparison
-
setValue() public
Sets the value
-
sql() public
Convert the expression into a SQL fragment.
-
traverse() public
Traverses the tree of expressions stored in this object, visiting first expressions in the left hand side and then the rest.
Method Detail
__clone() ¶ public
__clone(): voidCreate a deep clone.
Clones the field and value if they are expression objects.
Returns
void__construct() ¶ public
__construct(string|arrayCake\Database\ExpressionInterface $fields, arrayCake\Database\ExpressionInterface $values, array $types = [], string $conjunction = '=')Constructor
Parameters
-
string|arrayCake\Database\ExpressionInterface$fields the fields to use to form a tuple
-
arrayCake\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() ¶ protected
_bindValue(Cake\Database\ValueBinder $generator, mixed $value, string $type): stringRegisters a value in the placeholder generator and returns the generated placeholder
Parameters
-
Cake\Database\ValueBinder$generator The value binder
-
mixed$value The value to bind
-
string$type The type to use
Returns
string_castToExpression() ¶ protected
_castToExpression(mixed $value, string $type): mixedConditionally 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$type The type name
Returns
mixed_collectExpressions() ¶ protected
_collectExpressions(arrayTraversable $values): arrayReturns an array with the original $values in the first position and all ExpressionInterface objects that could be found in the second position.
Parameters
-
arrayTraversable$values The rows to insert
Returns
array_flattenValue() ¶ protected
_flattenValue(arrayTraversable $value, Cake\Database\ValueBinder $generator, string|array|null $type = 'string'): stringConverts a traversable value into a set of placeholders generated by
$generator and separated by ,
Parameters
-
arrayTraversable$value the value to flatten
-
Cake\Database\ValueBinder$generator The value binder to use
-
string|array|null$type optional the type to cast values to
Returns
string_requiresToExpressionCasting() ¶ protected
_requiresToExpressionCasting(array $types): arrayReturns 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
array_stringExpression() ¶ protected
_stringExpression(Cake\Database\ValueBinder $generator): arrayReturns a template and a placeholder for the value after registering it with the placeholder $generator
Parameters
-
Cake\Database\ValueBinder$generator The value binder to use.
Returns
array_stringifyValues() ¶ protected
_stringifyValues(Cake\Database\ValueBinder $generator): stringReturns a string with the values as placeholders in a string to be used for the SQL version of this expression
Parameters
-
Cake\Database\ValueBinder$generator The value binder to convert expressions with.
Returns
string_traverseValue() ¶ protected
_traverseValue(mixed $value, callable $callable): voidConditionally executes the callback for the passed value if it is an ExpressionInterface
Parameters
-
mixed$value The value to traverse
-
callable$callable The callable to use when traversing
Returns
voidgetField() ¶ public
getField(): stringCake\Database\ExpressionInterfaceReturns the field name
Returns
stringCake\Database\ExpressionInterfacegetOperator() ¶ public
getOperator(): stringReturns the operator used for comparison
Returns
stringgetType() ¶ public
getType(): arrayReturns the type to be used for casting the value to a database representation
Returns
arrayisMulti() ¶ public
isMulti(): boolDetermines if each of the values in this expressions is a tuple in itself
Returns
boolsetField() ¶ public
setField(stringCake\Database\ExpressionInterface $field): voidSets the field name
Parameters
-
stringCake\Database\ExpressionInterface$field The field to compare with.
Returns
voidsetOperator() ¶ public
setOperator(string $operator): voidSets the operator to use for the comparison
Parameters
-
string$operator The operator to be used for the comparison.
Returns
voidsetValue() ¶ public
setValue(mixed $value): voidSets the value
Parameters
-
mixed$value The value to compare
Returns
voidsql() ¶ public
sql(Cake\Database\ValueBinder $generator): stringConvert the expression into a SQL fragment.
Parameters
-
Cake\Database\ValueBinder$generator Placeholder generator object
Returns
stringtraverse() ¶ public
traverse(callable $visitor): voidTraverses 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
Parameters
-
callable$visitor The callable to apply to sub-expressions
Returns
voidProperty Detail
$_field ¶ protected
The field name or expression to be used in the left hand side of the operator
Type
stringCake\Database\ExpressionInterface$_type ¶ protected
The type to be used for casting the value to a database representation
Type
array$_valueExpressions ¶ protected
A cached list of ExpressionInterface objects that were found in the value for this expression.
Type
Cake\Database\ExpressionInterface[]