www.aleph1.co.uk Git - yaffs-website/blob - web/core/lib/Drupal/Core/Entity/Query/ConditionAggregateInterface.php

   1 <?php
   2
   3 namespace Drupal\Core\Entity\Query;
   4
   5 /**
   6  * Defines aggregated entity query conditions.
   7  */
   8 interface ConditionAggregateInterface extends \Countable {
   9
  10   /**
  11    * Gets the current conjunction.
  12    *
  13    * @return string
  14    *   Can be AND or OR.
  15    */
  16   public function getConjunction();
  17
  18   /**
  19    * Adds a condition.
  20    *
  21    * @param string|ConditionAggregateInterface $field
  22    * @param string $function
  23    * @param mixed $value
  24    * @param string $operator
  25    * @param string $langcode
  26    *
  27    * @return \Drupal\Core\Entity\Query\ConditionAggregateInterface
  28    *   The called object.
  29    * @see \Drupal\Core\Entity\Query\QueryInterface::condition()
  30    */
  31   public function condition($field, $function = NULL, $value = NULL, $operator = NULL, $langcode = NULL);
  32
  33   /**
  34    * Queries for the existence of a field.
  35    *
  36    * @param $field
  37    * @param string $langcode
  38    * @return ConditionInterface
  39    * @see \Drupal\Core\Entity\Query\QueryInterface::exists()
  40    */
  41   public function exists($field, $function, $langcode = NULL);
  42
  43   /**
  44    * Queries for the nonexistence of a field.
  45    *
  46    * @param string $field
  47    * @return ConditionInterface
  48    * @see \Drupal\Core\Entity\Query\QueryInterface::notexists()
  49    */
  50   public function notExists($field, $function, $langcode = NULL);
  51
  52   /**
  53    * Gets a complete list of all conditions in this conditional clause.
  54    *
  55    * This method returns by reference. That allows alter hooks to access the
  56    * data structure directly and manipulate it before it gets compiled.
  57    *
  58    * @return array
  59    */
  60   public function &conditions();
  61
  62   /**
  63    * Compiles this conditional clause.
  64    *
  65    * @param $query
  66    *   The query object this conditional clause belongs to.
  67    */
  68   public function compile($query);
  69
  70 }