\Cake\Database\ExpressionCaseExpression

This class represents a SQL Case statement

Summary

Methods
Properties
Constants
__construct()
add()
elseValue()
sql()
traverse()
No public properties found
No constants found
_castToExpression()
_requiresToExpressionCasting()
_addExpressions()
_compile()
$_conditions
$_values
$_elseValue
N/A
No private methods found
No private properties found
N/A

Properties

$_conditions

$_conditions : array

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"

Type

array

$_values

$_values : array

Values that are associated with the conditions in the $_conditions array.

Each value represents the 'true' value for the condition with the corresponding key.

Type

array

$_elseValue

$_elseValue : string|\Cake\Database\ExpressionInterface|array|null

The `ELSE` value for the case statement. If null then no `ELSE` will be included.

Type

string|\Cake\Database\ExpressionInterface|array|null

Methods

__construct()

__construct(array|\Cake\Database\ExpressionInterface  $conditions = array(), array|\Cake\Database\ExpressionInterface  $values = array(), array  $types = array()) 

Constructs the case expression

Parameters

array|\Cake\Database\ExpressionInterface $conditions

The conditions to test. Must be a ExpressionInterface instance, or an array of ExpressionInterface instances.

array|\Cake\Database\ExpressionInterface $values

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 ELSE value

array $types

associative array of types to be associated with the values passed in $values

add()

add(array|\Cake\Database\ExpressionInterface  $conditions = array(), array|\Cake\Database\ExpressionInterface  $values = array(), array  $types = array()) : $this

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

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

Returns

$this

elseValue()

elseValue(\Cake\Database\ExpressionInterface|string|array|null  $value = null, string|null  $type = null) : void

Sets the default value

Parameters

\Cake\Database\ExpressionInterface|string|array|null $value

Value to set

string|null $type

Type of value

sql()

sql(\Cake\Database\ValueBinder  $generator) : string

Converts the Node into a SQL string fragment.

Parameters

\Cake\Database\ValueBinder $generator

Placeholder generator object

Returns

string

traverse()

traverse(callable  $visitor) : void

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.

_castToExpression()

_castToExpression(mixed  $value, string  $type) : mixed

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

mixed

_requiresToExpressionCasting()

_requiresToExpressionCasting(array  $types) : array

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

array

_addExpressions()

_addExpressions(array|\Cake\Database\ExpressionInterface  $conditions, array|\Cake\Database\ExpressionInterface  $values, array  $types) : void

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()

_compile(array|string|\Cake\Database\ExpressionInterface  $part, \Cake\Database\ValueBinder  $generator) : string

Compiles the relevant parts into sql

Parameters

array|string|\Cake\Database\ExpressionInterface $part

The part to compile

\Cake\Database\ValueBinder $generator

Sql generator

Returns

string