class QueryAggregate
Same name in this branch
- 11.x core/lib/Drupal/Core/Entity/Query/Sql/QueryAggregate.php \Drupal\Core\Entity\Query\Sql\QueryAggregate
Same name in other branches
- 9 core/modules/workspaces/src/EntityQuery/QueryAggregate.php \Drupal\workspaces\EntityQuery\QueryAggregate
- 9 core/lib/Drupal/Core/Entity/Query/Sql/QueryAggregate.php \Drupal\Core\Entity\Query\Sql\QueryAggregate
- 8.9.x core/modules/workspaces/src/EntityQuery/QueryAggregate.php \Drupal\workspaces\EntityQuery\QueryAggregate
- 8.9.x core/lib/Drupal/Core/Entity/Query/Sql/QueryAggregate.php \Drupal\Core\Entity\Query\Sql\QueryAggregate
- 10 core/modules/workspaces/src/EntityQuery/QueryAggregate.php \Drupal\workspaces\EntityQuery\QueryAggregate
- 10 core/lib/Drupal/Core/Entity/Query/Sql/QueryAggregate.php \Drupal\Core\Entity\Query\Sql\QueryAggregate
Alters aggregate entity queries to use a workspace revision if possible.
Hierarchy
- class \Drupal\Core\Entity\Query\QueryBase implements \Drupal\Core\Entity\Query\QueryInterface
- class \Drupal\Core\Entity\Query\Sql\Query extends \Drupal\Core\Entity\Query\QueryBase implements \Drupal\Core\Entity\Query\QueryInterface
- class \Drupal\Core\Entity\Query\Sql\QueryAggregate extends \Drupal\Core\Entity\Query\Sql\Query implements \Drupal\Core\Entity\Query\QueryAggregateInterface
- class \Drupal\workspaces\EntityQuery\QueryAggregate extends \Drupal\Core\Entity\Query\Sql\QueryAggregate uses \Drupal\workspaces\EntityQuery\QueryTrait
- class \Drupal\Core\Entity\Query\Sql\QueryAggregate extends \Drupal\Core\Entity\Query\Sql\Query implements \Drupal\Core\Entity\Query\QueryAggregateInterface
- class \Drupal\Core\Entity\Query\Sql\Query extends \Drupal\Core\Entity\Query\QueryBase implements \Drupal\Core\Entity\Query\QueryInterface
Expanded class hierarchy of QueryAggregate
2 string references to 'QueryAggregate'
- QueryFactory::getAggregate in core/
modules/ workspaces/ src/ EntityQuery/ QueryFactory.php - Instantiates an aggregation query object for a given entity type.
- QueryFactory::getAggregate in core/
lib/ Drupal/ Core/ Entity/ Query/ Sql/ QueryFactory.php - Instantiates an aggregation query object for a given entity type.
File
-
core/
modules/ workspaces/ src/ EntityQuery/ QueryAggregate.php, line 10
Namespace
Drupal\workspaces\EntityQueryView source
class QueryAggregate extends BaseQueryAggregate {
use QueryTrait {
prepare as traitPrepare;
}
/**
* {@inheritdoc}
*/
public function prepare() {
// Aggregate entity queries do not return an array of entity IDs keyed by
// revision IDs, they only return the values of the aggregated fields, so we
// don't need to add any expressions like we do in
// \Drupal\workspaces\EntityQuery\Query::prepare().
$this->traitPrepare();
// Throw away the ID fields.
$this->sqlFields = [];
return $this;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Member alias | Overriden Title | Overrides |
---|---|---|---|---|---|---|
Query::$connection | protected | property | ||||
Query::$sqlFields | protected | property | An array of fields keyed by the field alias. | |||
Query::$sqlGroupBy | protected | property | An array of strings for the SQL 'group by' operation. | |||
Query::$sqlQuery | protected | property | The build sql select query. | |||
Query::$tables | protected | property | The Tables object for this 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::__clone | public | function | Implements the magic __clone method. | Overrides QueryBase::__clone | ||
Query::__toString | public | function | Implements the magic __toString method. | |||
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 | public | 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 QueryAggregate::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. | |||
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::$conjunction | protected | property | Defines how the conditions on the query need to match. | |||
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::$latestRevision | protected | property | Flag indicating whether to query the latest revision. | |||
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 | Enables or disables access checking for this query. | 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::alter | protected | function | Invoke hooks to allow modules to alter the entity query. | |||
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 | Limits the query to only default revisions. | 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 its 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::latestRevision | public | function | Queries the latest revision. | Overrides QueryInterface::latestRevision | ||
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 | Defines the range of the query. | Overrides QueryInterface::range | ||
QueryBase::sort | public | function | Sorts the result set by a given field. | Overrides QueryInterface::sort | ||
QueryBase::sortAggregate | public | function | ||||
QueryBase::tableSort | public | function | Enables sortable tables for this query. | Overrides QueryInterface::tableSort | ||
QueryTrait::$workspaceInfo | protected | property | The workspace information service. | |||
QueryTrait::$workspaceManager | protected | property | The workspace manager. | |||
QueryTrait::isSimpleQuery | public | function | ||||
QueryTrait::prepare | public | function | Aliased as: traitPrepare | |||
QueryTrait::__construct | public | function | Constructs a Query object. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.