This class represents a function call string in a SQL statement. Calls can be constructed by passing the name of the function and a list of params. For security reasons, all params passed are quoted by default unless explicitly told otherwise.
arrayA list of strings or other expression objects that represent the "branches" of the expression tree. For example one key of the array might look like "sum > :value"
stringString to be used for joining each of the internal expressions this object internally stores for example "AND", "OR", etc.
stringThe name of the function to be constructed when generating the SQL string
stringThe type name this expression will return when executed
Cake\Database\TypeMap|nullClone this object and its subtree of expressions.
Constructor. Takes a name for the function to be invoked and a list of params to be passed into the function. Optionally you can pass a list of types to be used for each bound param.
Auxiliary function used for decomposing a nested array of conditions and build a tree structure inside this object to represent the full SQL expression. String conditions are stored directly in the conditions, while any other representation is wrapped around an adequate instance or of this class.
Returns the type name for the passed field if it was stored in the typeMap
Conditionally converts the passed value to an ExpressionInterface object if the type class implements the ExpressionTypeInterface. Otherwise, returns the value unmodified.
Parses a string conditions by trying to extract the operator inside it if any and finally returning either an adequate QueryExpression object or a plain string representation of the condition. This function is responsible for generating the placeholders and replacing the values by them, while storing the value elsewhere for future binding.
Returns an array with the types that require values to be casted to expressions, out of the list of type names passed as parameter.
Adds one or more arguments for the function call.
Adds a new case expression to the expression object
Returns a new QueryExpression object containing all the conditions passed and set up the conjunction to be "AND"
Returns a new QueryExpression object containing all the conditions passed and set up the conjunction to be "AND"
Adds a new condition to the expression object in the form "field BETWEEN from AND to".
Returns a new case expression object.
The name of the function is in itself an expression to generate, thus always adding 1 to the amount of expressions stored in this object.
Adds a new condition to the expression object in the form "field = value".
Builds equal condition or assignment with identifier wrapping.
Adds a new condition to the expression object in the form "EXISTS (...)".
Gets the currently configured conjunction for the conditions at this level of the expression tree.
Gets default types of current type map.
Gets the name of the SQL function to be invoke in this expression.
Gets the type of the value this object will generate.
Returns the existing type map.
Adds a new condition to the expression object in the form "field > value".
Adds a new condition to the expression object in the form "field >= value".
Returns true if this expression contains any other nested ExpressionInterface objects
Adds a new condition to the expression object in the form "field IN (value1, value2)".
Check whether a callable is acceptable.
Adds a new condition to the expression object in the form "field IS NOT NULL".
Adds a new condition to the expression object in the form "field IS NULL".
Executes a callable function for each of the parts that form this expression.
Adds a new condition to the expression object in the form "field LIKE value".
Adds a new condition to the expression object in the form "field < value".
Adds a new condition to the expression object in the form "field <= value".
Adds a new set of conditions to this level of the tree and negates the final result by prepending a NOT, it will look like "NOT ( (condition1) AND (conditions2) )" conjunction depends on the one currently configured for this object.
Adds a new condition to the expression object in the form "field != value".
Adds a new condition to the expression object in the form "NOT EXISTS (...)".
Adds a new condition to the expression object in the form "field NOT IN (value1, value2)".
Adds a new condition to the expression object in the form "(field NOT IN (value1, value2) OR field IS NULL".
Adds a new condition to the expression object in the form "field NOT LIKE value".
Returns a new QueryExpression object containing all the conditions passed and set up the conjunction to be "OR"
Returns a new QueryExpression object containing all the conditions passed and set up the conjunction to be "OR"
Changes the conjunction for the conditions at this level of the expression tree.
Overwrite the default type mappings for fields in the implementing object.
Sets the name of the SQL function to be invoke in this expression.
Sets the type of the value this object will generate.
Creates a new TypeMap if $typeMap is an array, otherwise exchanges it for the given one.
Converts the Node into a SQL string fragment.
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.
__clone(): void
Clone this object and its subtree of expressions.
void__construct(string $name, array $params = [], array<string, string>|array<string|null> $types = [], string $returnType = 'string')
Constructor. Takes a name for the function to be invoked and a list of params to be passed into the function. Optionally you can pass a list of types to be used for each bound param.
By default, all params that are passed will be quoted. If you wish to use literal arguments, you need to explicitly hint this function.
$f = new FunctionExpression('CONCAT', ['CakePHP', ' rules']);
Previous line will generate CONCAT('CakePHP', ' rules')
$f = new FunctionExpression('CONCAT', ['name' => 'literal', ' rules']);
Will produce CONCAT(name, ' rules')
string $name the name of the function to be constructed
array $params optional list of arguments to be passed to the function If associative the key would be used as argument when value is 'literal'
array<string, string>|array<string|null> $types optional Associative array of types to be associated with the passed arguments
string $returnType optional The return type of this expression
_addConditions(array $conditions, array<int|string, string> $types): void
Auxiliary function used for decomposing a nested array of conditions and build a tree structure inside this object to represent the full SQL expression. String conditions are stored directly in the conditions, while any other representation is wrapped around an adequate instance or of this class.
array $conditions list of conditions to be stored in this object
array<int|string, string> $types list of types associated on fields referenced in $conditions
void_calculateType(Cake\Database\ExpressionInterface|string $field): string|null
Returns the type name for the passed field if it was stored in the typeMap
Cake\Database\ExpressionInterface|string $field The field name to get a type for.
string|null_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.
mixed $value The value to convert to ExpressionInterface
string|null $type optional The type name
mixed_parseCondition(string $field, mixed $value): Cake\Database\ExpressionInterface
Parses a string conditions by trying to extract the operator inside it if any and finally returning either an adequate QueryExpression object or a plain string representation of the condition. This function is responsible for generating the placeholders and replacing the values by them, while storing the value elsewhere for future binding.
string $field The value from which the actual field and operator will be extracted.
mixed $value The value to be bound to a placeholder for the field
Cake\Database\ExpressionInterfaceInvalidArgumentException_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.
array $types List of type names
arrayadd(array $conditions, array<string, string> $types = [], bool $prepend = false): $this
Adds one or more arguments for the function call.
array $conditions list of arguments to be passed to the function If associative the key would be used as argument when value is 'literal'
array<string, string> $types optional Associative array of types to be associated with the passed arguments
bool $prepend optional Whether to prepend or append to the list of arguments
$thisaddCase(Cake\Database\ExpressionInterface|array $conditions, Cake\Database\ExpressionInterface|array $values = [], array<string> $types = []): $this
Adds a new case expression to the expression object
Cake\Database\ExpressionInterface|array $conditions The conditions to test. Must be a ExpressionInterface instance, or an array of ExpressionInterface instances.
Cake\Database\ExpressionInterface|array $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 ELSE value.
array<string> $types optional Associative array of types to be associated with the values passed in $values
$thisand(Cake\Database\ExpressionInterfaceClosure|array|string $conditions, array<string, string> $types = []): Cake\Database\Expression\QueryExpression
Returns a new QueryExpression object containing all the conditions passed and set up the conjunction to be "AND"
Cake\Database\ExpressionInterfaceClosure|array|string $conditions to be joined with AND
array<string, string> $types optional Associative array of fields pointing to the type of the values that are being passed. Used for correctly binding values to statements.
Cake\Database\Expression\QueryExpressionand_(Cake\Database\ExpressionInterfaceClosure|array|string $conditions, array<string, string> $types = []): Cake\Database\Expression\QueryExpression
Returns a new QueryExpression object containing all the conditions passed and set up the conjunction to be "AND"
Cake\Database\ExpressionInterfaceClosure|array|string $conditions to be joined with AND
array<string, string> $types optional Associative array of fields pointing to the type of the values that are being passed. Used for correctly binding values to statements.
Cake\Database\Expression\QueryExpressionbetween(Cake\Database\ExpressionInterface|string $field, mixed $from, mixed $to, string|null $type = null): $this
Adds a new condition to the expression object in the form "field BETWEEN from AND to".
Cake\Database\ExpressionInterface|string $field The field name to compare for values inbetween the range.
mixed $from The initial value of the range.
mixed $to The ending value in the comparison range.
string|null $type optional the type name for $value as configured using the Type map.
$thiscase(Cake\Database\ExpressionInterface|object|scalar|null $value = null, string|null $type = null): Cake\Database\Expression\CaseStatementExpression
Returns a new case expression object.
When a value is set, the syntax generated is CASE case_value WHEN when_value ... END (simple case), where the when_value's are compared against the case_value.
When no value is set, the syntax generated is CASE WHEN when_conditions ... END (searched case), where the conditions hold the comparisons.
Note that null is a valid case value, and thus should only be passed if you actually want to create the simple case expression variant!
Cake\Database\ExpressionInterface|object|scalar|null $value optional The case value.
string|null $type optional The case value type. If no type is provided, the type will be tried to be inferred from the value.
Cake\Database\Expression\CaseStatementExpressioncount(): int
The name of the function is in itself an expression to generate, thus always adding 1 to the amount of expressions stored in this object.
inteq(Cake\Database\ExpressionInterface|string $field, mixed $value, string|null $type = null): $this
Adds a new condition to the expression object in the form "field = value".
Cake\Database\ExpressionInterface|string $field Database field to be compared against value
mixed $value The value to be bound to $field for comparison
string|null $type optional the type name for $value as configured using the Type map. If it is suffixed with "[]" and the value is an array then multiple placeholders will be created, one per each value in the array.
$thisequalFields(string $leftField, string $rightField): $this
Builds equal condition or assignment with identifier wrapping.
string $leftField Left join condition field name.
string $rightField Right join condition field name.
$thisexists(Cake\Database\ExpressionInterface $expression): $this
Adds a new condition to the expression object in the form "EXISTS (...)".
Cake\Database\ExpressionInterface $expression the inner query
$thisgetConjunction(): string
Gets the currently configured conjunction for the conditions at this level of the expression tree.
stringgetDefaultTypes(): array<int|string, string>
Gets default types of current type map.
array<int|string, string>getName(): string
Gets the name of the SQL function to be invoke in this expression.
stringgetReturnType(): string
Gets the type of the value this object will generate.
stringgetTypeMap(): Cake\Database\TypeMap
Returns the existing type map.
Cake\Database\TypeMapgt(Cake\Database\ExpressionInterface|string $field, mixed $value, string|null $type = null): $this
Adds a new condition to the expression object in the form "field > value".
Cake\Database\ExpressionInterface|string $field Database field to be compared against value
mixed $value The value to be bound to $field for comparison
string|null $type optional the type name for $value as configured using the Type map.
$thisgte(Cake\Database\ExpressionInterface|string $field, mixed $value, string|null $type = null): $this
Adds a new condition to the expression object in the form "field >= value".
Cake\Database\ExpressionInterface|string $field Database field to be compared against value
mixed $value The value to be bound to $field for comparison
string|null $type optional the type name for $value as configured using the Type map.
$thishasNestedExpression(): bool
Returns true if this expression contains any other nested ExpressionInterface objects
boolin(Cake\Database\ExpressionInterface|string $field, Cake\Database\ExpressionInterface|array|string $values, string|null $type = null): $this
Adds a new condition to the expression object in the form "field IN (value1, value2)".
Cake\Database\ExpressionInterface|string $field Database field to be compared against value
Cake\Database\ExpressionInterface|array|string $values the value to be bound to $field for comparison
string|null $type optional the type name for $value as configured using the Type map.
$thisisCallable(Cake\Database\ExpressionInterface|callable|array|string $callable): bool
Check whether a callable is acceptable.
We don't accept ['class', 'method'] style callbacks, as they often contain user input and arrays of strings are easy to sneak in.
Cake\Database\ExpressionInterface|callable|array|string $callable The callable to check.
boolisNotNull(Cake\Database\ExpressionInterface|string $field): $this
Adds a new condition to the expression object in the form "field IS NOT NULL".
Cake\Database\ExpressionInterface|string $field database field to be tested for not null
$thisisNull(Cake\Database\ExpressionInterface|string $field): $this
Adds a new condition to the expression object in the form "field IS NULL".
Cake\Database\ExpressionInterface|string $field database field to be tested for null
$thisiterateParts(callable $callback): $this
Executes a callable function for each of the parts that form this expression.
The callable function is required to return a value with which the currently visited part will be replaced. If the callable function returns null then the part will be discarded completely from this expression.
The callback function will receive each of the conditions as first param and the key as second param. It is possible to declare the second parameter as passed by reference, this will enable you to change the key under which the modified part is stored.
callable $callback The callable to apply to each part.
$thislike(Cake\Database\ExpressionInterface|string $field, mixed $value, string|null $type = null): $this
Adds a new condition to the expression object in the form "field LIKE value".
Cake\Database\ExpressionInterface|string $field Database field to be compared against value
mixed $value The value to be bound to $field for comparison
string|null $type optional the type name for $value as configured using the Type map.
$thislt(Cake\Database\ExpressionInterface|string $field, mixed $value, string|null $type = null): $this
Adds a new condition to the expression object in the form "field < value".
Cake\Database\ExpressionInterface|string $field Database field to be compared against value
mixed $value The value to be bound to $field for comparison
string|null $type optional the type name for $value as configured using the Type map.
$thislte(Cake\Database\ExpressionInterface|string $field, mixed $value, string|null $type = null): $this
Adds a new condition to the expression object in the form "field <= value".
Cake\Database\ExpressionInterface|string $field Database field to be compared against value
mixed $value The value to be bound to $field for comparison
string|null $type optional the type name for $value as configured using the Type map.
$thisnot(Cake\Database\ExpressionInterfaceClosure|array|string $conditions, array<string, string> $types = []): $this
Adds a new set of conditions to this level of the tree and negates the final result by prepending a NOT, it will look like "NOT ( (condition1) AND (conditions2) )" conjunction depends on the one currently configured for this object.
Cake\Database\ExpressionInterfaceClosure|array|string $conditions to be added and negated
array<string, string> $types optional Associative array of fields pointing to the type of the values that are being passed. Used for correctly binding values to statements.
$thisnotEq(Cake\Database\ExpressionInterface|string $field, mixed $value, string|null $type = null): $this
Adds a new condition to the expression object in the form "field != value".
Cake\Database\ExpressionInterface|string $field Database field to be compared against value
mixed $value The value to be bound to $field for comparison
string|null $type optional the type name for $value as configured using the Type map. If it is suffixed with "[]" and the value is an array then multiple placeholders will be created, one per each value in the array.
$thisnotExists(Cake\Database\ExpressionInterface $expression): $this
Adds a new condition to the expression object in the form "NOT EXISTS (...)".
Cake\Database\ExpressionInterface $expression the inner query
$thisnotIn(Cake\Database\ExpressionInterface|string $field, Cake\Database\ExpressionInterface|array|string $values, string|null $type = null): $this
Adds a new condition to the expression object in the form "field NOT IN (value1, value2)".
Cake\Database\ExpressionInterface|string $field Database field to be compared against value
Cake\Database\ExpressionInterface|array|string $values the value to be bound to $field for comparison
string|null $type optional the type name for $value as configured using the Type map.
$thisnotInOrNull(Cake\Database\ExpressionInterface|string $field, Cake\Database\ExpressionInterface|array|string $values, string|null $type = null): $this
Adds a new condition to the expression object in the form "(field NOT IN (value1, value2) OR field IS NULL".
Cake\Database\ExpressionInterface|string $field Database field to be compared against value
Cake\Database\ExpressionInterface|array|string $values the value to be bound to $field for comparison
string|null $type optional the type name for $value as configured using the Type map.
$thisnotLike(Cake\Database\ExpressionInterface|string $field, mixed $value, string|null $type = null): $this
Adds a new condition to the expression object in the form "field NOT LIKE value".
Cake\Database\ExpressionInterface|string $field Database field to be compared against value
mixed $value The value to be bound to $field for comparison
string|null $type optional the type name for $value as configured using the Type map.
$thisor(Cake\Database\ExpressionInterfaceClosure|array|string $conditions, array<string, string> $types = []): Cake\Database\Expression\QueryExpression
Returns a new QueryExpression object containing all the conditions passed and set up the conjunction to be "OR"
Cake\Database\ExpressionInterfaceClosure|array|string $conditions to be joined with OR
array<string, string> $types optional Associative array of fields pointing to the type of the values that are being passed. Used for correctly binding values to statements.
Cake\Database\Expression\QueryExpressionor_(Cake\Database\ExpressionInterfaceClosure|array|string $conditions, array<string, string> $types = []): Cake\Database\Expression\QueryExpression
Returns a new QueryExpression object containing all the conditions passed and set up the conjunction to be "OR"
Cake\Database\ExpressionInterfaceClosure|array|string $conditions to be joined with OR
array<string, string> $types optional Associative array of fields pointing to the type of the values that are being passed. Used for correctly binding values to statements.
Cake\Database\Expression\QueryExpressionsetConjunction(string $conjunction): $this
Changes the conjunction for the conditions at this level of the expression tree.
string $conjunction Value to be used for joining conditions
$thissetDefaultTypes(array<int|string, string> $types): $this
Overwrite the default type mappings for fields in the implementing object.
This method is useful if you need to set type mappings that are shared across multiple functions/expressions in a query.
To add a default without overwriting existing ones use getTypeMap()->addDefaults()
array<int|string, string> $types The array of types to set.
$thissetName(string $name): $this
Sets the name of the SQL function to be invoke in this expression.
string $name The name of the function
$thissetReturnType(string $type): $this
Sets the type of the value this object will generate.
string $type The name of the type that is to be returned
$thissetTypeMap(Cake\Database\TypeMap|array $typeMap): $this
Creates a new TypeMap if $typeMap is an array, otherwise exchanges it for the given one.
Cake\Database\TypeMap|array $typeMap Creates a TypeMap if array, otherwise sets the given TypeMap
$thissql(Cake\Database\ValueBinder $binder): string
Converts the Node into a SQL string fragment.
Cake\Database\ValueBinder $binder stringtraverse(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.
Closure $callback $thisA list of strings or other expression objects that represent the "branches" of the expression tree. For example one key of the array might look like "sum > :value"
arrayString to be used for joining each of the internal expressions this object internally stores for example "AND", "OR", etc.
stringThe name of the function to be constructed when generating the SQL string
stringThe type name this expression will return when executed
stringCake\Database\TypeMap|null
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/class-Cake.Database.Expression.FunctionExpression.html