Class FunctionExpression

Properties summary

• $_conditions protected
  array

  A 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"

• $_conjunction protected
  string

  String to be used for joining each of the internal expressions this object internally stores for example "AND", "OR", etc.

• $_name protected
  string

  The name of the function to be constructed when generating the SQL string

• $_returnType protected
  string

  The type name this expression will return when executed

• $_typeMap protected
  \Cake\Database\TypeMap

Method Summary

• __clone() public

  Clone this object and its subtree of expressions.

• __construct() public

  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.

• _addConditions() protected

  Auxiliary function used for decomposing a nested array of conditions and build a tree structure inside this object to represent the full SQL expression.

• _calculateType() protected

  Returns the type name for the passed field if it was stored in the typeMap

• _castToExpression() protected

  Conditionally converts the passed value to an ExpressionInterface object if the type class implements the ExpressionTypeInterface. Otherwise, returns the value unmodified.

• _parseCondition() protected

  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.

• _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.

• add() public

  Adds one or more arguments for the function call.

• addCase() public

  Adds a new case expression to the expression object

• and() public

  Returns a new QueryExpression object containing all the conditions passed and set up the conjunction to be "AND"

• and_() public

  Returns a new QueryExpression object containing all the conditions passed and set up the conjunction to be "AND"

• between() public

  Adds a new condition to the expression object in the form "field BETWEEN from AND to".

• count() public

  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.

• eq() public

  Adds a new condition to the expression object in the form "field = value".

• equalFields() public

  Builds equal condition or assignment with identifier wrapping.

• exists() public

  Adds a new condition to the expression object in the form "EXISTS (...)".

• getConjunction() public

  Gets the currently configured conjunction for the conditions at this level of the expression tree.

• getDefaultTypes() public

  Gets default types of current type map.

• getName() public

  Gets the name of the SQL function to be invoke in this expression.

• getReturnType() public

  Gets the type of the value this object will generate.

• getTypeMap() public

  Returns the existing type map.

• gt() public

  Adds a new condition to the expression object in the form "field > value".

• gte() public

  Adds a new condition to the expression object in the form "field >= value".

• hasNestedExpression() public

  Returns true if this expression contains any other nested ExpressionInterface objects

• in() public

  Adds a new condition to the expression object in the form "field IN (value1, value2)".

• isCallable() public

  Check whether or not a callable is acceptable.

• isNotNull() public

  Adds a new condition to the expression object in the form "field IS NOT NULL".

• isNull() public

  Adds a new condition to the expression object in the form "field IS NULL".

• iterateParts() public

  Executes a callable function for each of the parts that form this expression.

• like() public

  Adds a new condition to the expression object in the form "field LIKE value".

• lt() public

  Adds a new condition to the expression object in the form "field < value".

• lte() public

  Adds a new condition to the expression object in the form "field <= value".

• not() public

  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.

• notEq() public

  Adds a new condition to the expression object in the form "field != value".

• notExists() public

  Adds a new condition to the expression object in the form "NOT EXISTS (...)".

• notIn() public

  Adds a new condition to the expression object in the form "field NOT IN (value1, value2)".

• notLike() public

  Adds a new condition to the expression object in the form "field NOT LIKE value".

• or() public

  Returns a new QueryExpression object containing all the conditions passed and set up the conjunction to be "OR"

• or_() public

  Returns a new QueryExpression object containing all the conditions passed and set up the conjunction to be "OR"

• setConjunction() public

  Changes the conjunction for the conditions at this level of the expression tree.

• setDefaultTypes() public

  Overwrite the default type mappings for fields in the implementing object.

• setName() public

  Sets the name of the SQL function to be invoke in this expression.

• setReturnType() public

  Sets the type of the value this object will generate.

• setTypeMap() public

  Creates a new TypeMap if $typeMap is an array, otherwise exchanges it for the given one.

• sql() public

  Returns the string representation of this object so that it can be used in a SQL query. Note that values condition values are not included in the string, in their place placeholders are put and can be replaced by the quoted values accordingly.

• traverse() public

  Traverses the tree structure of this query expression by executing a callback function for each of the conditions that are included in this object.

Method Detail

Property Detail