Class CaseExpression
This class represents a SQL Case statement
- Cake\Database\Expression\CaseExpression implements Cake\Database\ExpressionInterface uses Cake\Database\Type\ExpressionTypeCasterTrait
Properties summary
-
$_conditionsprotectedarrayA list of strings or other expression objects that represent the conditions of the case statement. For example one key of the array might look like "sum > :value"
-
$_elseValueprotectedstring|Cake\Database\ExpressionInterface|array|nullTheELSEvalue for the case statement. If null then noELSEwill be included. -
$_valuesprotectedarrayValues that are associated with the conditions in the $_conditions array. Each value represents the 'true' value for the condition with the corresponding key.
Method Summary
-
__construct() public
Constructs the case expression -
_addExpressions() protected
Iterates over the passed in conditions and ensures that there is a matching true value for each. If no matching true value, then it is defaulted to '1'.
-
_compile() protected
Compiles the relevant parts into sql -
add() public
Adds one or more conditions and their respective true values to the case object. Conditions must be a one dimensional array or a QueryExpression. The trueValues must be a similar structure, but may contain a string value.
-
elseValue() public
Sets the default value -
sql() public
Converts the Node into a SQL string fragment. -
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( array|Cake\Database\ExpressionInterface $conditions = [] , array|Cake\Database\ExpressionInterface $values = [] , array $types = [] )
Constructs the case expression
Parameters
-
array|
Cake\Database\ExpressionInterface$conditions optional [] The conditions to test. Must be a ExpressionInterface instance, or an array of ExpressionInterface instances.
-
array|
Cake\Database\ExpressionInterface$values optional [] associative array of values to be associated with the conditions passed in $conditions. If there are more $values than $conditions, the last $value is used as the
ELSEvalue- array $types optional []
associative array of types to be associated with the values passed in $values
_addExpressions() protected ¶
_addExpressions( array|Cake\Database\ExpressionInterface $conditions , array|Cake\Database\ExpressionInterface $values , array $types )
Iterates over the passed in conditions and ensures that there is a matching true value for each. If no matching true value, then it is defaulted to '1'.
Parameters
-
array|
Cake\Database\ExpressionInterface$conditions - Must be a ExpressionInterface instance, or an array of ExpressionInterface instances.
-
array|
Cake\Database\ExpressionInterface$values - associative array of values of each condition
- array $types
- associative array of types to be associated with the values
_compile() protected ¶
_compile( array|string|Cake\Database\ExpressionInterface $part , Cake\Database\ValueBinder $generator )
Compiles the relevant parts into sql
Parameters
-
array|string|
Cake\Database\ExpressionInterface$part - The part to compile
- Cake\Database\ValueBinder $generator
- Sql generator
Returns
add() public ¶
add( array|Cake\Database\ExpressionInterface $conditions = [] , array|Cake\Database\ExpressionInterface $values = [] , array $types = [] )
Adds one or more conditions and their respective true values to the case object. Conditions must be a one dimensional array or a QueryExpression. The trueValues must be a similar structure, but may contain a string value.
Parameters
-
array|
Cake\Database\ExpressionInterface$conditions optional [] - Must be a ExpressionInterface instance, or an array of ExpressionInterface instances.
-
array|
Cake\Database\ExpressionInterface$values optional [] - associative array of values of each condition
- array $types optional []
- associative array of types to be associated with the values
Returns
$this
elseValue() public ¶
elseValue( Cake\Database\ExpressionInterface|string|array|null $value = null , string|null $type = null )
Sets the default value
Parameters
-
Cake\Database\ExpressionInterface|string|array|null $value optional null - Value to set
- string|null $type optional null
- Type of value
sql() public ¶
sql( Cake\Database\ValueBinder $generator )
Converts the Node into a SQL string fragment.
Parameters
- Cake\Database\ValueBinder $generator
- Placeholder generator object
Returns
Implementation of
traverse() public ¶
traverse( callable $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
- callable $visitor
- The callable to apply to all nodes.
Implementation of
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
Properties detail
$_conditions ¶
A list of strings or other expression objects that represent the conditions of the case statement. For example one key of the array might look like "sum > :value"
[]
$_elseValue ¶
Cake\Database\ExpressionInterface|array|null
The ELSE value for the case statement. If null then no ELSE will be included.