interface ConditionAggregateInterface

Defines aggregated entity query conditions.

Hierarchy

Expanded class hierarchy of ConditionAggregateInterface

All classes that implement ConditionAggregateInterface

File

drupal/core/lib/Drupal/Core/Entity/Query/ConditionAggregateInterface.php, line 13
Contains \Drupal\Core\Entity\Query\ConditionAggregateInterface.

Namespace

Drupal\Core\Entity\Query
View source
interface ConditionAggregateInterface extends \Countable {

  /**
   * Gets the current conjunction.
   *
   * @return string
   *   Can be AND or OR.
   */
  public function getConjunction();

  /**
   * Adds a condition.
   *
   * @param string|ConditionAggregateInterface $field
   * @param string $function
   * @param mixed $value
   * @param string $operator
   * @param string $langcode
   *
   * @return \Drupal\Core\Entity\Query\ConditionAggregateInterface
   *   The called object.
   * @see \Drupal\Core\Entity\Query\QueryInterface::condition()
   */
  public function condition($field, $function = NULL, $value = NULL, $operator = NULL, $langcode = NULL);

  /**
   * Queries for the existence of a field.
   *
   * @param $field
   * @param string $langcode
   * @return ConditionInterface
   * @see \Drupal\Core\Entity\Query\QueryInterface::exists()
   */
  public function exists($field, $function, $langcode = NULL);

  /**
   * Queries for the nonexistence of a field.
   *
   * @param string $field
   * @return ConditionInterface;
   * @see \Drupal\Core\Entity\Query\QueryInterface::notexists()
   */
  public function notExists($field, $function, $langcode = NULL);

  /**
   * Gets a complete list of all conditions in this conditional clause.
   *
   * This method returns by reference. That allows alter hooks to access the
   * data structure directly and manipulate it before it gets compiled.
   *
   * @return array
   */
  public function &conditions();

  /**
   * Compiles this conditional clause.
   *
   * @param $query
   *   The query object this conditional clause belongs to.
   */
  public function compile($query);

}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
ConditionAggregateInterface::compile public function Compiles this conditional clause.
ConditionAggregateInterface::condition public function Adds a condition.
ConditionAggregateInterface::conditions public function Gets a complete list of all conditions in this conditional clause.
ConditionAggregateInterface::exists public function Queries for the existence of a field.
ConditionAggregateInterface::getConjunction public function Gets the current conjunction.
ConditionAggregateInterface::notExists public function Queries for the nonexistence of a field.