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
- Cake\Database\Expression\Comparison implements Cake\Database\ExpressionInterface, Cake\Database\Expression\FieldInterface uses Cake\Database\Type\ExpressionTypeCasterTrait , Cake\Database\Expression\FieldTrait
-
Cake\Database\Expression\TupleComparison
Inherited Properties
Method Summary
-
__construct() public
Constructor -
_bindValue() protected
Registers a value in the placeholder generator and returns the generated placeholder
-
_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
-
isMulti() public
Determines if each of the values in this expressions is a tuple in itself
-
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
__construct() public ¶
__construct( string|array|Cake\Database\ExpressionInterface $fields , array|Cake\Database\ExpressionInterface $values , array $types = [] , string $conjunction = '=' )
Constructor
Parameters
-
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
Overrides
_bindValue() protected ¶
_bindValue( Cake\Database\ValueBinder $generator , mixed $value , string $type )
Registers 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
generated placeholder
Overrides
_stringifyValues() protected ¶
_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
Parameters
- Cake\Database\ValueBinder $generator
- The value binder to convert expressions with.
Returns
_traverseValue() protected ¶
_traverseValue( mixed $value , callable $callable )
Conditionally 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
isMulti() public ¶
isMulti( )
Determines if each of the values in this expressions is a tuple in itself
Returns
sql() public ¶
sql( Cake\Database\ValueBinder $generator )
Convert the expression into a SQL fragment.
Parameters
- Cake\Database\ValueBinder $generator
- Placeholder generator object
Returns
Overrides
traverse() public ¶
traverse( callable $callable )
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
Parameters
- callable $callable
- The callable to apply to sub-expressions
Overrides
Methods inherited from Cake\Database\Expression\Comparison
__clone() public ¶
__clone( )
Create a deep clone.
Clones the field and value if they are expression objects.
_collectExpressions() protected ¶
_collectExpressions( array|Traversable $values )
Returns an array with the original $values in the first position and all ExpressionInterface objects that could be found in the second position.
Parameters
- array|Traversable $values
- The rows to insert
Returns
_flattenValue() protected ¶
_flattenValue( array|Traversable $value , Cake\Database\ValueBinder $generator , string|array|null $type = 'string' )
Converts a traversable value into a set of placeholders generated by
$generator and separated by ,
Parameters
- array|Traversable $value
- the value to flatten
- Cake\Database\ValueBinder $generator
- The value binder to use
- string|array|null $type optional 'string'
- the type to cast values to
Returns
_stringExpression() protected ¶
_stringExpression( Cake\Database\ValueBinder $generator )
Returns 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
First position containing the template and the second a placeholder
setOperator() public ¶
setOperator( string $operator )
Sets the operator to use for the comparison
Parameters
- string $operator
- The operator to be used for the comparison.
setValue() public ¶
setValue( mixed $value )
Sets the value
Parameters
- mixed $value
- The value to compare
Methods used from Cake\Database\Type\ExpressionTypeCasterTrait
_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 $type
- The type name
Returns
_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
Methods used from Cake\Database\Expression\FieldTrait
setField() public ¶
setField( string|Cake\Database\ExpressionInterface $field )
Sets the field name
Parameters
-
string|
Cake\Database\ExpressionInterface$field - The field to compare with.