You are here

Home » API reference » Zircon Profile 8 » QueryAggregate.php

class QueryAggregate in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/lib/Drupal/Core/Entity/Query/Sql/QueryAggregate.php \Drupal\Core\Entity\Query\Sql\QueryAggregate

The SQL storage entity query aggregate class.

Hierarchy

Expanded class hierarchy of QueryAggregate

1 string reference to 'QueryAggregate'
QueryFactory::getAggregate in core/lib/Drupal/Core/Entity/Query/Sql/QueryFactory.php
Instantiates an aggregation query object for a given entity type.

File

core/lib/Drupal/Core/Entity/Query/Sql/QueryAggregate.php, line 15
Contains \Drupal\Core\Entity\Query\Sql\QueryAggregate.

Namespace

Drupal\Core\Entity\Query\Sql
View source 
class QueryAggregate extends Query implements QueryAggregateInterface {

  /**
   * Stores the sql expressions used to build the sql query.
   *
   * @var array
   *   An array of expressions.
   */
  protected $sqlExpressions = array();

  /**
   * {@inheritdoc}
   */
  public function execute() {
    return $this
      ->prepare()
      ->addAggregate()
      ->compile()
      ->compileAggregate()
      ->addGroupBy()
      ->addSort()
      ->addSortAggregate()
      ->finish()
      ->result();
  }

  /**
   * {@inheritdoc}
   */
  public function prepare() {
    parent::prepare();

    // Throw away the id fields.
    $this->sqlFields = array();
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function conditionAggregateGroupFactory($conjunction = 'AND') {
    $class = static::getClass($this->namespaces, 'ConditionAggregate');
    return new $class($conjunction, $this, $this->namespaces);
  }

  /**
   * {@inheritdoc}
   */
  public function existsAggregate($field, $function, $langcode = NULL) {
    return $this->conditionAggregate
      ->exists($field, $function, $langcode);
  }

  /**
   * {@inheritdoc}
   */
  public function notExistsAggregate($field, $function, $langcode = NULL) {
    return $this->conditionAggregate
      ->notExists($field, $function, $langcode);
  }

  /**
   * Adds the aggregations to the query.
   *
   * @return \Drupal\Core\Entity\Query\Sql\QueryAggregate
   *   Returns the called object.
   */
  protected function addAggregate() {
    if ($this->aggregate) {
      foreach ($this->aggregate as $aggregate) {
        $sql_field = $this
          ->getSqlField($aggregate['field'], $aggregate['langcode']);
        $this->sqlExpressions[$aggregate['alias']] = $aggregate['function'] . "({$sql_field})";
      }
    }
    return $this;
  }

  /**
   * Builds the aggregation conditions part of the query.
   *
   * @return \Drupal\Core\Entity\Query\Sql\QueryAggregate
   *   Returns the called object.
   */
  protected function compileAggregate() {
    $this->conditionAggregate
      ->compile($this->sqlQuery);
    return $this;
  }

  /**
   * Adds the groupby values to the actual query.
   *
   * @return \Drupal\Core\Entity\Query\Sql\QueryAggregate
   *   Returns the called object.
   */
  protected function addGroupBy() {
    foreach ($this->groupBy as $group_by) {
      $field = $group_by['field'];
      $sql_field = $this
        ->getSqlField($field, $group_by['langcode']);
      $this->sqlGroupBy[$sql_field] = $sql_field;
      list($table, $real_sql_field) = explode('.', $sql_field);
      $this->sqlFields[$sql_field] = array(
        $table,
        $real_sql_field,
        $this
          ->createSqlAlias($field, $real_sql_field),
      );
    }
    return $this;
  }

  /**
   * Builds the aggregation sort part of the query.
   *
   * @return \Drupal\Core\Entity\Query\Sql\QueryAggregate
   *   Returns the called object.
   */
  protected function addSortAggregate() {
    if (!$this->count) {
      foreach ($this->sortAggregate as $alias => $sort) {
        $this->sqlQuery
          ->orderBy($alias, $sort['direction']);
      }
    }
    return $this;
  }

  /**
   * Overrides \Drupal\Core\Entity\Query\Sql\Query::finish().
   *
   * Adds the sql expressions to the query.
   */
  protected function finish() {
    foreach ($this->sqlExpressions as $alias => $expression) {
      $this->sqlQuery
        ->addExpression($expression, $alias);
    }
    return parent::finish();
  }

  /**
   * Builds a sql alias as expected in the result.
   *
   * @param string $field
   *   The field as passed in by the caller.
   * @param string $sql_field
   *   The sql field as returned by getSqlField.
   * @return string
   *   The SQL alias expected in the return value. The dots in $sql_field are
   *   replaced with underscores and if a default fallback to .value happened,
   *   the _value is stripped.
   */
  function createSqlAlias($field, $sql_field) {
    $alias = str_replace('.', '_', $sql_field);

    // If the alias contains of field_*_value remove the _value at the end.
    if (substr($alias, 0, 6) === 'field_' && substr($field, -6) !== '_value' && substr($alias, -6) === '_value') {
      $alias = substr($alias, 0, -6);
    }
    return $alias;
  }

  /**
   * Overrides \Drupal\Core\Entity\Query\Sql\Query::result().
   *
   * @return array|int
   *   Returns the aggregated result, or a number if it's a count query.
   */
  protected function result() {
    if ($this->count) {
      return parent::result();
    }
    $return = array();
    foreach ($this->sqlQuery
      ->execute() as $row) {
      $return[] = (array) $row;
    }
    return $return;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Query::$connection protected property
Query::$entityManager protected property Stores the entity manager used by the query.
Query::$sqlFields protected property An array of fields keyed by the field alias.
Query::$sqlGroupBy protected property An array of strings added as to the group by, keyed by the string to avoid duplicates.
Query::$sqlQuery protected property The build sql select query.
Query::addSort protected function Adds the sort to the build query.
Query::compile protected function Compiles the conditions.
Query::getSqlField protected function Constructs a select expression for a given field and language.
Query::getTables public function Gets the Tables object for this query.
Query::isSimpleQuery protected function Determines whether the query requires GROUP BY and ORDER BY MIN/MAX.
Query::__clone public function Implements the magic __clone method. Overrides QueryBase::__clone
Query::__construct public function Constructs a query object. Overrides QueryBase::__construct
QueryAggregate::$sqlExpressions protected property Stores the sql expressions used to build the sql query.
QueryAggregate::addAggregate protected function Adds the aggregations to the query.
QueryAggregate::addGroupBy protected function Adds the groupby values to the actual query.
QueryAggregate::addSortAggregate protected function Builds the aggregation sort part of the query.
QueryAggregate::compileAggregate protected function Builds the aggregation conditions part of the query.
QueryAggregate::conditionAggregateGroupFactory public function Creates an object holding a group of conditions. Overrides QueryAggregateInterface::conditionAggregateGroupFactory
QueryAggregate::createSqlAlias function Builds a sql alias as expected in the result.
QueryAggregate::execute public function Execute the query. Overrides Query::execute
QueryAggregate::existsAggregate public function Queries for the existence of a field. Overrides QueryAggregateInterface::existsAggregate
QueryAggregate::finish protected function Overrides \Drupal\Core\Entity\Query\Sql\Query::finish(). Overrides Query::finish
QueryAggregate::notExistsAggregate public function Queries for the nonexistence of a field. Overrides QueryAggregateInterface::notExistsAggregate
QueryAggregate::prepare public function Prepares the basic query with proper metadata/tags and base fields. Overrides Query::prepare
QueryAggregate::result protected function Overrides \Drupal\Core\Entity\Query\Sql\Query::result(). Overrides Query::result
QueryBase::$accessCheck protected property Whether access check is requested or not. Defaults to TRUE.
QueryBase::$aggregate protected property The list of aggregate expressions.
QueryBase::$allRevisions protected property Flag indicating whether to query the current revision or all revisions.
QueryBase::$alterMetaData protected property The query metadata for alter purposes.
QueryBase::$alterTags protected property The query tags.
QueryBase::$condition protected property Conditions. 1
QueryBase::$conditionAggregate protected property Aggregate Conditions
QueryBase::$count protected property TRUE if this is a count query, FALSE if it isn't.
QueryBase::$entityType protected property Information about the entity type. 1
QueryBase::$entityTypeId protected property The entity type this query runs against.
QueryBase::$groupBy protected property The list of columns to group on.
QueryBase::$namespaces protected property List of potential namespaces of the classes belonging to this query.
QueryBase::$pager protected property The query pager data.
QueryBase::$range protected property The query range.
QueryBase::$sort protected property The list of sorts.
QueryBase::$sortAggregate protected property The list of sorts over the aggregate results.
QueryBase::accessCheck public function Overrides QueryInterface::accessCheck
QueryBase::addMetaData public function Adds additional metadata to the query. Overrides AlterableInterface::addMetaData
QueryBase::addTag public function Adds a tag to a query. Overrides AlterableInterface::addTag
QueryBase::aggregate public function
QueryBase::allRevisions public function Queries all the revisions. Overrides QueryInterface::allRevisions
QueryBase::andConditionGroup public function Creates a new group of conditions ANDed together. Overrides QueryInterface::andConditionGroup
QueryBase::condition public function Add a condition to the query or a condition group. Overrides QueryInterface::condition 1
QueryBase::conditionAggregate public function
QueryBase::conditionGroupFactory protected function Creates an object holding a group of conditions.
QueryBase::count public function Makes this a count query. Overrides QueryInterface::count
QueryBase::currentRevision public function Queries the current revision. Overrides QueryInterface::currentRevision
QueryBase::exists public function Queries for a non-empty value on a field. Overrides QueryInterface::exists
QueryBase::getAggregationAlias protected function Generates an alias for a field and it's aggregated function.
QueryBase::getClass public static function Finds a class in a list of namespaces.
QueryBase::getEntityTypeId public function Gets the ID of the entity type for this query. Overrides QueryInterface::getEntityTypeId
QueryBase::getMetaData public function Retrieves a given piece of metadata. Overrides AlterableInterface::getMetaData
QueryBase::getNamespaces public static function Gets a list of namespaces of the ancestors of a class.
QueryBase::groupBy public function
QueryBase::hasAllTags public function Determines if a given query has all specified tags. Overrides AlterableInterface::hasAllTags
QueryBase::hasAnyTag public function Determines if a given query has any specified tag. Overrides AlterableInterface::hasAnyTag
QueryBase::hasTag public function Determines if a given query has a given tag. Overrides AlterableInterface::hasTag
QueryBase::initializePager protected function Gets the total number of results and initialize a pager for the query.
QueryBase::notExists public function Queries for an empty field. Overrides QueryInterface::notExists
QueryBase::orConditionGroup public function Creates a new group of conditions ORed together. Overrides QueryInterface::orConditionGroup
QueryBase::pager public function Enables a pager for the query. Overrides QueryInterface::pager
QueryBase::range public function Overrides QueryInterface::range
QueryBase::sort public function Overrides QueryInterface::sort
QueryBase::sortAggregate public function
QueryBase::tableSort public function Enables sortable tables for this query. Overrides QueryInterface::tableSort