Class FunctionsBuilder
Contains methods related to generating FunctionExpression objects with most commonly used SQL functions. This acts as a factory for FunctionExpression objects.
Method Summary
-
__call() public
Magic method dispatcher to create custom SQL function calls
-
_build() protected
Returns a new instance of a FunctionExpression. This is used for generating arbitrary function calls in the final SQL string.
-
_literalArgumentFunction() protected
Helper function to build a function expression that only takes one literal argument.
-
avg() public
Returns a FunctionExpression representing a call to SQL AVG function.
-
cast() public
Returns a FunctionExpression representing a call to SQL CAST function.
-
coalesce() public
Returns a FunctionExpression representing a call to SQL COALESCE function.
-
concat() public
Returns a FunctionExpression representing a string concatenation
-
count() public
Returns a FunctionExpression representing a call to SQL COUNT function.
-
dateAdd() public
Add the time unit to the date expression
-
dateDiff() public
Returns a FunctionExpression representing the difference in days between two dates.
-
datePart() public
Returns the specified date part from the SQL expression.
-
dayOfWeek() public
Returns a FunctionExpression representing a call to SQL WEEKDAY function. 1 - Sunday, 2 - Monday, 3 - Tuesday...
-
extract() public
Returns the specified date part from the SQL expression.
-
max() public
Returns a FunctionExpression representing a call to SQL MAX function.
-
min() public
Returns a FunctionExpression representing a call to SQL MIN function.
-
now() public
Returns a FunctionExpression representing a call that will return the current date and time. By default it returns both date and time, but you can also make it generate only the date or only the time.
-
rand() public
Returns a FunctionExpression representing a call to SQL RAND function.
-
sum() public
Returns a FunctionExpression representing a call to SQL SUM function.
-
weekday() public
Returns a FunctionExpression representing a call to SQL WEEKDAY function. 1 - Sunday, 2 - Monday, 3 - Tuesday...
Method Detail
__call() ¶ public
__call(string $name, array $args): Cake\Database\Expression\FunctionExpressionMagic method dispatcher to create custom SQL function calls
Parameters
-
string$name the SQL function name to construct
-
array$args list with up to 3 arguments, first one being an array with parameters for the SQL function, the second one a list of types to bind to those params, and the third one the return type of the function
Returns
Cake\Database\Expression\FunctionExpression_build() ¶ protected
_build(string $name, array $params = [], array $types = [], string $return = 'string'): Cake\Database\Expression\FunctionExpressionReturns a new instance of a FunctionExpression. This is used for generating arbitrary function calls in the final SQL string.
Parameters
-
string$name the name of the SQL function to constructed
-
array$params optional list of params to be passed to the function
-
array$types optional list of types for each function param
-
string$return optional The return type of the function expression
Returns
Cake\Database\Expression\FunctionExpression_literalArgumentFunction() ¶ protected
_literalArgumentFunction(string $name, string|Cake\Database\ExpressionInterface $expression, array $types = [], string $return = 'string'): Cake\Database\Expression\FunctionExpressionHelper function to build a function expression that only takes one literal argument.
Parameters
-
string$name name of the function to build
-
string|Cake\Database\ExpressionInterface$expression the function argument
-
array$types optional list of types to bind to the arguments
-
string$return optional The return type for the function
Returns
Cake\Database\Expression\FunctionExpressionavg() ¶ public
avg(string|Cake\Database\ExpressionInterface $expression, array $types = []): Cake\Database\Expression\FunctionExpressionReturns a FunctionExpression representing a call to SQL AVG function.
Parameters
-
string|Cake\Database\ExpressionInterface$expression the function argument
-
array$types optional list of types to bind to the arguments
Returns
Cake\Database\Expression\FunctionExpressioncast() ¶ public
cast(string|Cake\Database\ExpressionInterface $field, string $type = ''): Cake\Database\Expression\FunctionExpressionReturns a FunctionExpression representing a call to SQL CAST function.
Parameters
-
string|Cake\Database\ExpressionInterface$field Field or expression to cast.
-
string$type optional The target data type
Returns
Cake\Database\Expression\FunctionExpressioncoalesce() ¶ public
coalesce(array $args, array $types = []): Cake\Database\Expression\FunctionExpressionReturns a FunctionExpression representing a call to SQL COALESCE function.
Parameters
-
array$args List of expressions to evaluate as function parameters
-
array$types optional list of types to bind to the arguments
Returns
Cake\Database\Expression\FunctionExpressionconcat() ¶ public
concat(array $args, array $types = []): Cake\Database\Expression\FunctionExpressionReturns a FunctionExpression representing a string concatenation
Parameters
-
array$args List of strings or expressions to concatenate
-
array$types optional list of types to bind to the arguments
Returns
Cake\Database\Expression\FunctionExpressioncount() ¶ public
count(string|Cake\Database\ExpressionInterface $expression, array $types = []): Cake\Database\Expression\FunctionExpressionReturns a FunctionExpression representing a call to SQL COUNT function.
Parameters
-
string|Cake\Database\ExpressionInterface$expression the function argument
-
array$types optional list of types to bind to the arguments
Returns
Cake\Database\Expression\FunctionExpressiondateAdd() ¶ public
dateAdd(string|Cake\Database\ExpressionInterface $expression, string|int $value, string $unit, array $types = []): Cake\Database\Expression\FunctionExpressionAdd the time unit to the date expression
Parameters
-
string|Cake\Database\ExpressionInterface$expression Expression to obtain the date part from.
-
string|int$value Value to be added. Use negative to subtract.
-
string$unit Unit of the value e.g. hour or day.
-
array$types optional list of types to bind to the arguments
Returns
Cake\Database\Expression\FunctionExpressiondateDiff() ¶ public
dateDiff(array $args, array $types = []): Cake\Database\Expression\FunctionExpressionReturns a FunctionExpression representing the difference in days between two dates.
Parameters
-
array$args List of expressions to obtain the difference in days.
-
array$types optional list of types to bind to the arguments
Returns
Cake\Database\Expression\FunctionExpressiondatePart() ¶ public
datePart(string $part, string|Cake\Database\ExpressionInterface $expression, array $types = []): Cake\Database\Expression\FunctionExpressionReturns the specified date part from the SQL expression.
Parameters
-
string$part Part of the date to return.
-
string|Cake\Database\ExpressionInterface$expression Expression to obtain the date part from.
-
array$types optional list of types to bind to the arguments
Returns
Cake\Database\Expression\FunctionExpressiondayOfWeek() ¶ public
dayOfWeek(string|Cake\Database\ExpressionInterface $expression, array $types = []): Cake\Database\Expression\FunctionExpressionReturns a FunctionExpression representing a call to SQL WEEKDAY function. 1 - Sunday, 2 - Monday, 3 - Tuesday...
Parameters
-
string|Cake\Database\ExpressionInterface$expression the function argument
-
array$types optional list of types to bind to the arguments
Returns
Cake\Database\Expression\FunctionExpressionextract() ¶ public
extract(string $part, string|Cake\Database\ExpressionInterface $expression, array $types = []): Cake\Database\Expression\FunctionExpressionReturns the specified date part from the SQL expression.
Parameters
-
string$part Part of the date to return.
-
string|Cake\Database\ExpressionInterface$expression Expression to obtain the date part from.
-
array$types optional list of types to bind to the arguments
Returns
Cake\Database\Expression\FunctionExpressionmax() ¶ public
max(string|Cake\Database\ExpressionInterface $expression, array $types = []): Cake\Database\Expression\FunctionExpressionReturns a FunctionExpression representing a call to SQL MAX function.
Parameters
-
string|Cake\Database\ExpressionInterface$expression the function argument
-
array$types optional list of types to bind to the arguments
Returns
Cake\Database\Expression\FunctionExpressionmin() ¶ public
min(string|Cake\Database\ExpressionInterface $expression, array $types = []): Cake\Database\Expression\FunctionExpressionReturns a FunctionExpression representing a call to SQL MIN function.
Parameters
-
string|Cake\Database\ExpressionInterface$expression the function argument
-
array$types optional list of types to bind to the arguments
Returns
Cake\Database\Expression\FunctionExpressionnow() ¶ public
now(string $type = 'datetime'): Cake\Database\Expression\FunctionExpressionReturns a FunctionExpression representing a call that will return the current date and time. By default it returns both date and time, but you can also make it generate only the date or only the time.
Parameters
-
string$type optional (datetime|date|time)
Returns
Cake\Database\Expression\FunctionExpressionrand() ¶ public
rand(): Cake\Database\Expression\FunctionExpressionReturns a FunctionExpression representing a call to SQL RAND function.
Returns
Cake\Database\Expression\FunctionExpressionsum() ¶ public
sum(string|Cake\Database\ExpressionInterface $expression, array $types = []): Cake\Database\Expression\FunctionExpressionReturns a FunctionExpression representing a call to SQL SUM function.
Parameters
-
string|Cake\Database\ExpressionInterface$expression the function argument
-
array$types optional list of types to bind to the arguments
Returns
Cake\Database\Expression\FunctionExpressionweekday() ¶ public
weekday(string|Cake\Database\ExpressionInterface $expression, array $types = []): Cake\Database\Expression\FunctionExpressionReturns a FunctionExpression representing a call to SQL WEEKDAY function. 1 - Sunday, 2 - Monday, 3 - Tuesday...
Parameters
-
string|Cake\Database\ExpressionInterface$expression the function argument
-
array$types optional list of types to bind to the arguments
Returns
Cake\Database\Expression\FunctionExpression