Class QueryExpression

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.

Inherited Properties

• _typeMap

Method Summary

• __call() public

  Helps calling the and() and or() methods transparently.

• __clone() public

  Clone this object and its subtree of expressions.

• __construct() public

  Constructor. A new expression object can be created without any params and be built dynamically. Otherwise it is possible to pass an array of conditions containing either a tree-like array structure to be parsed and/or other expression objects. Optionally, you can set the conjunction keyword to be used for joining each part of this level of the expression tree.

• _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. String conditions are stored directly in the conditions, while any other representation is wrapped around an adequate instance or of this class.

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

• 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. Useful to determine if this expression object is void or it will generate a non-empty string when compiled

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

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

• setConjunction() public

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

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

• tieWith() public

  Changes the conjunction for the conditions at this level of the expression tree. If called with no arguments it will return the currently configured value.

• 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. Useful for compiling the final expression, or doing introspection in the structure.

• type() public

  Backwards compatible wrapper for tieWith()

Method Detail

Methods used from Cake\Database\TypeMapTrait

Properties detail

[]