Class ComparisonExpression

A Comparison is a type of query expression that represents an operation involving a field an operator and a value. In its most common form the string representation of a comparison is field = value

Namespace: Cake\Database\Expression

Property Summary

$_field protected

Cake\Database\ExpressionInterface|array|string

The field name or expression to be used in the left hand side of the operator
$_isMultiple protected

bool

Whether the value in this expression is a traversable
$_operator protected

string

The operator used for comparing field and value
$_type protected

string|null

The type to be used for casting the value to a database representation
$_value protected

mixed

The value to be used in the right hand side of the operation
$_valueExpressions protected

array<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 $binder 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 $binder
getField() public

Returns the field name
getOperator() public

Returns the operator used for comparison
getValue() public

Returns the value used for comparison
setField() public

Sets the field name
setOperator() public

Sets the operator to use for the comparison
setValue() public

Sets the 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 $callback callable passing as first parameter the instance of the expression currently being iterated.

Method Detail

__clone() ¶ public

__clone(): void

Create a deep clone.

Clones the field and value if they are expression objects.

Returns

void

__construct() ¶ public

__construct(Cake\Database\ExpressionInterface|string $field, mixed $value, string|null $type = null, string $operator = '=')

Constructor

Parameters

Cake\Database\ExpressionInterface|string $field: the field name to compare to a value
mixed $value: The value to be used in comparison
string|null $type optional: the type name used to cast the value
string $operator optional: the operator used for comparing field and value

_bindValue() ¶ protected

_bindValue(mixed $value, Cake\Database\ValueBinder $binder, string|null $type = null): string

Registers a value in the placeholder generator and returns the generated placeholder

Parameters

mixed $value: The value to bind
Cake\Database\ValueBinder $binder: The value binder to use
string|null $type optional: The type of $value

Returns

string

generated placeholder

_castToExpression() ¶ protected

_castToExpression(mixed $value, string|null $type = null): 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 convert to ExpressionInterface
string|null $type optional: The type name

Returns

mixed

_collectExpressions() ¶ protected

_collectExpressions(Cake\Database\ExpressionInterface|iterable $values): array

Returns an array with the original $values in the first position and all ExpressionInterface objects that could be found in the second position.

Parameters

Cake\Database\ExpressionInterface|iterable $values: The rows to insert

Returns

array

_flattenValue() ¶ protected

_flattenValue(iterable $value, Cake\Database\ValueBinder $binder, string|null $type = null): string

Converts a traversable value into a set of placeholders generated by $binder and separated by ,

Parameters

iterable $value: the value to flatten
Cake\Database\ValueBinder $binder: The value binder to use
string|null $type optional: the type to cast values to

Returns

string

_requiresToExpressionCasting() ¶ protected

_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

_stringExpression() ¶ protected

_stringExpression(Cake\Database\ValueBinder $binder): array

Returns a template and a placeholder for the value after registering it with the placeholder $binder

Parameters

Cake\Database\ValueBinder $binder: The value binder to use.

Returns

array

First position containing the template and the second a placeholder

getField() ¶ public

getField(): Cake\Database\ExpressionInterface|array|string

Returns the field name

Returns

Cake\Database\ExpressionInterface|array|string

getOperator() ¶ public

getOperator(): string

Returns the operator used for comparison

Returns

string

getValue() ¶ public

getValue(): mixed

Returns the value used for comparison

Returns

mixed

setField() ¶ public

setField(Cake\Database\ExpressionInterface|array|string $field): void

Sets the field name

Parameters

Cake\Database\ExpressionInterface|array|string $field: The field to compare with.

Returns

void

setOperator() ¶ public

setOperator(string $operator): void

Sets the operator to use for the comparison

Parameters

string $operator: The operator to be used for the comparison.

Returns

void

setValue() ¶ public

setValue(mixed $value): void

Sets the value

Parameters

mixed $value: The value to compare

Returns

void

sql() ¶ public

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

Converts the Node into a SQL string fragment.

Parameters

Cake\Database\ValueBinder $binder

Returns

string

traverse() ¶ public

traverse(Closure $callback): $this

Iterates over each part of the expression recursively for every level of the expressions tree and executes the $callback callable passing as first parameter the instance of the expression currently being iterated.

Parameters

Closure $callback

Returns

$this

Property Detail

`$_field` ¶ protected

The field name or expression to be used in the left hand side of the operator

Type

Cake\Database\ExpressionInterface|array|string

`$_isMultiple` ¶ protected

Whether the value in this expression is a traversable

Type

bool

`$_operator` ¶ protected

The operator used for comparing field and value

Type

string

`$_type` ¶ protected

The type to be used for casting the value to a database representation

Type

string|null

`$_value` ¶ protected

The value to be used in the right hand side of the operation

Type

mixed

`$_valueExpressions` ¶ protected

A cached list of ExpressionInterface objects that were found in the value for this expression.

Type

array<Cake\Database\ExpressionInterface>

Namespaces

Class ComparisonExpression

Property Summary

Method Summary

__clone() public

__construct() public

_bindValue() protected

_castToExpression() protected

_collectExpressions() protected

_flattenValue() protected

_requiresToExpressionCasting() protected

_stringExpression() protected

getField() public

getOperator() public

getValue() public

setField() public

setOperator() public

setValue() public

sql() public

traverse() public

Method Detail

__clone() ¶ public

Returns

__construct() ¶ public

Parameters

_bindValue() ¶ protected

Parameters

Returns

_castToExpression() ¶ protected

Parameters

Returns

_collectExpressions() ¶ protected

Parameters

Returns

_flattenValue() ¶ protected

Parameters

Returns

_requiresToExpressionCasting() ¶ protected

Parameters

Returns

_stringExpression() ¶ protected

Parameters

Returns

getField() ¶ public

Returns

getOperator() ¶ public

Returns

getValue() ¶ public

Returns

setField() ¶ public

Parameters

Returns

setOperator() ¶ public

Parameters

Returns

setValue() ¶ public

Parameters

Returns

sql() ¶ public

Parameters

Returns

traverse() ¶ public

Parameters

Returns

Property Detail

$_field ¶ protected

Type

$_isMultiple ¶ protected

Type

$_operator ¶ protected

Type

$_type ¶ protected

Type

$_value ¶ protected

Type

$_valueExpressions ¶ protected

Type

`$_field` ¶ protected

`$_isMultiple` ¶ protected

`$_operator` ¶ protected

`$_type` ¶ protected

`$_value` ¶ protected

`$_valueExpressions` ¶ protected