Class OrderByExpression

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.

• $_typeMap protected
  \Cake\Database\TypeMap

Method Summary

• __clone() public

  Clone this object and its subtree of expressions.

• __construct() public

  Constructor

• _addConditions() protected

  Auxiliary function used for decomposing a nested array of conditions and building 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

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

• add() public

  Adds one or more conditions to this expression object. Conditions can be expressed in a one dimensional array, that will cause all conditions to be added directly at this level of the tree or they can be nested arbitrarily making it create more expression objects that will be nested inside and configured to use the specified conjunction.

• 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

  Returns the number of internal conditions that are stored in this expression.

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

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

• setTypeMap() public

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

• sql() public

  Convert the expression into a SQL fragment.

• 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