class QueryBase
Same name in other branches
- 9 core/lib/Drupal/Core/Entity/Query/QueryBase.php \Drupal\Core\Entity\Query\QueryBase
- 8.9.x core/lib/Drupal/Core/Entity/Query/QueryBase.php \Drupal\Core\Entity\Query\QueryBase
- 10 core/lib/Drupal/Core/Entity/Query/QueryBase.php \Drupal\Core\Entity\Query\QueryBase
The base entity query class.
Hierarchy
- class \Drupal\Core\Entity\Query\QueryBase implements \Drupal\Core\Entity\Query\QueryInterface
Expanded class hierarchy of QueryBase
9 files declare their use of QueryBase
- ConditionAggregate.php in core/
lib/ Drupal/ Core/ Entity/ Query/ Sql/ ConditionAggregate.php - Query.php in core/
lib/ Drupal/ Core/ Config/ Entity/ Query/ Query.php - Query.php in core/
lib/ Drupal/ Core/ Entity/ Query/ Sql/ Query.php - Query.php in core/
lib/ Drupal/ Core/ Entity/ Query/ Null/ Query.php - Query.php in core/
lib/ Drupal/ Core/ Entity/ KeyValueStore/ Query/ Query.php
File
-
core/
lib/ Drupal/ Core/ Entity/ Query/ QueryBase.php, line 11
Namespace
Drupal\Core\Entity\QueryView source
abstract class QueryBase implements QueryInterface {
/**
* The entity type this query runs against.
*
* @var string
*/
protected $entityTypeId;
/**
* Information about the entity type.
*
* @var \Drupal\Core\Entity\EntityTypeInterface
*/
protected $entityType;
/**
* The list of sorts.
*
* @var array
*/
protected $sort = [];
/**
* TRUE if this is a count query, FALSE if it isn't.
*
* @var bool
*/
protected $count = FALSE;
/**
* Conditions.
*
* @var \Drupal\Core\Entity\Query\ConditionInterface
*/
protected $condition;
/**
* The list of aggregate expressions.
*
* @var array
*/
protected $aggregate = [];
/**
* The list of columns to group on.
*
* @var array
*/
protected $groupBy = [];
/**
* Aggregate Conditions.
*
* @var \Drupal\Core\Entity\Query\ConditionAggregateInterface
*/
protected $conditionAggregate;
/**
* The list of sorts over the aggregate results.
*
* @var array
*/
protected $sortAggregate = [];
/**
* The query range.
*
* @var array
*/
protected $range = [];
/**
* The query metadata for alter purposes.
*
* @var array
*/
protected $alterMetaData;
/**
* The query tags.
*
* @var array
*/
protected $alterTags;
/**
* Whether access check is requested or not.
*
* @var bool|null
*/
protected $accessCheck;
/**
* Flag indicating whether to query the current revision or all revisions.
*
* @var bool
*/
protected $allRevisions = FALSE;
/**
* Flag indicating whether to query the latest revision.
*
* @var bool
*/
protected $latestRevision = FALSE;
/**
* The query pager data.
*
* @var array
*
* @see Query::pager()
*/
protected $pager = [];
/**
* List of potential namespaces of the classes belonging to this query.
*
* @var array
*/
protected $namespaces = [];
/**
* Defines how the conditions on the query need to match.
*/
protected string $conjunction;
/**
* Constructs this object.
*
* @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
* The entity type definition.
* @param string $conjunction
* - AND: all of the conditions on the query need to match.
* - OR: at least one of the conditions on the query need to match.
* @param array $namespaces
* List of potential namespaces of the classes belonging to this query.
*/
public function __construct(EntityTypeInterface $entity_type, $conjunction, array $namespaces) {
$this->entityTypeId = $entity_type->id();
$this->entityType = $entity_type;
$this->conjunction = $conjunction;
$this->namespaces = $namespaces;
$this->condition = $this->conditionGroupFactory($conjunction);
if ($this instanceof QueryAggregateInterface) {
$this->conditionAggregate = $this->conditionAggregateGroupFactory($conjunction);
}
}
/**
* {@inheritdoc}
*/
public function getEntityTypeId() {
return $this->entityTypeId;
}
/**
* {@inheritdoc}
*/
public function condition($property, $value = NULL, $operator = NULL, $langcode = NULL) {
$this->condition
->condition($property, $value, $operator, $langcode);
return $this;
}
/**
* {@inheritdoc}
*/
public function exists($property, $langcode = NULL) {
$this->condition
->exists($property, $langcode);
return $this;
}
/**
* {@inheritdoc}
*/
public function notExists($property, $langcode = NULL) {
$this->condition
->notExists($property, $langcode);
return $this;
}
/**
* {@inheritdoc}
*/
public function range($start = NULL, $length = NULL) {
$this->range = is_null($start) && is_null($length) ? [] : [
'start' => $start ?? 0,
'length' => $length,
];
return $this;
}
/**
* Creates an object holding a group of conditions.
*
* See andConditionGroup() and orConditionGroup() for more.
*
* @param string $conjunction
* - AND (default): this is the equivalent of andConditionGroup().
* - OR: this is the equivalent of orConditionGroup().
*
* @return \Drupal\Core\Entity\Query\ConditionInterface
* An object holding a group of conditions.
*/
protected function conditionGroupFactory($conjunction = 'AND') {
$class = static::getClass($this->namespaces, 'Condition');
return new $class($conjunction, $this, $this->namespaces);
}
/**
* {@inheritdoc}
*/
public function andConditionGroup() {
return $this->conditionGroupFactory('and');
}
/**
* {@inheritdoc}
*/
public function orConditionGroup() {
return $this->conditionGroupFactory('or');
}
/**
* {@inheritdoc}
*/
public function sort($field, $direction = 'ASC', $langcode = NULL) {
$this->sort[] = [
'field' => $field,
'direction' => strtoupper($direction),
'langcode' => $langcode,
];
return $this;
}
/**
* {@inheritdoc}
*/
public function count() {
$this->count = TRUE;
return $this;
}
/**
* {@inheritdoc}
*/
public function accessCheck($access_check = TRUE) {
$this->accessCheck = $access_check;
return $this;
}
/**
* {@inheritdoc}
*/
public function currentRevision() {
$this->allRevisions = FALSE;
$this->latestRevision = FALSE;
return $this;
}
/**
* {@inheritdoc}
*/
public function latestRevision() {
$this->allRevisions = TRUE;
$this->latestRevision = TRUE;
return $this;
}
/**
* {@inheritdoc}
*/
public function allRevisions() {
$this->allRevisions = TRUE;
$this->latestRevision = FALSE;
return $this;
}
/**
* {@inheritdoc}
*/
public function pager($limit = 10, $element = NULL) {
// Even when not using SQL, storing the element PagerSelectExtender is as
// good as anywhere else.
if (!isset($element)) {
$element = \Drupal::service('pager.manager')->getMaxPagerElementId() + 1;
}
$this->pager = [
'limit' => $limit,
'element' => $element,
];
return $this;
}
/**
* Gets the total number of results and initialize a pager for the query.
*
* The pager can be disabled by either setting the pager limit to 0, or by
* setting this query to be a count query.
*/
protected function initializePager() {
if ($this->pager && !empty($this->pager['limit']) && !$this->count) {
$page = \Drupal::service('pager.parameters')->findPage($this->pager['element']);
$count_query = clone $this;
$this->pager['total'] = $count_query->count()
->execute();
$this->pager['start'] = $page * $this->pager['limit'];
\Drupal::service('pager.manager')->createPager($this->pager['total'], $this->pager['limit'], $this->pager['element']);
$this->range($this->pager['start'], $this->pager['limit']);
}
}
/**
* {@inheritdoc}
*/
public function tableSort(&$headers) {
// If 'field' is not initialized, the header columns aren't clickable.
foreach ($headers as $key => $header) {
if (is_array($header) && isset($header['specifier'])) {
$headers[$key]['field'] = '';
}
}
$order = TableSort::getOrder($headers, \Drupal::request());
$direction = TableSort::getSort($headers, \Drupal::request());
foreach ($headers as $header) {
if (is_array($header) && $header['data'] == $order['name']) {
$this->sort($header['specifier'], $direction, $header['langcode'] ?? NULL);
}
}
return $this;
}
/**
* Makes sure that the Condition object is cloned as well.
*/
public function __clone() {
$this->condition = clone $this->condition;
}
/**
* {@inheritdoc}
*/
public function addTag($tag) {
$this->alterTags[$tag] = 1;
return $this;
}
/**
* {@inheritdoc}
*/
public function hasTag($tag) {
return isset($this->alterTags[$tag]);
}
/**
* {@inheritdoc}
*/
public function hasAllTags() {
return !(bool) array_diff(func_get_args(), array_keys($this->alterTags));
}
/**
* {@inheritdoc}
*/
public function hasAnyTag() {
return (bool) array_intersect(func_get_args(), array_keys($this->alterTags));
}
/**
* {@inheritdoc}
*/
public function addMetaData($key, $object) {
$this->alterMetaData[$key] = $object;
return $this;
}
/**
* {@inheritdoc}
*/
public function getMetaData($key) {
return $this->alterMetaData[$key] ?? NULL;
}
/**
* {@inheritdoc}
*/
public function aggregate($field, $function, $langcode = NULL, &$alias = NULL) {
if (!isset($alias)) {
$alias = $this->getAggregationAlias($field, $function);
}
$this->aggregate[$alias] = [
'field' => $field,
'function' => $function,
'alias' => $alias,
'langcode' => $langcode,
];
return $this;
}
/**
* {@inheritdoc}
*/
public function conditionAggregate($field, $function = NULL, $value = NULL, $operator = '=', $langcode = NULL) {
$this->aggregate($field, $function, $langcode);
$this->conditionAggregate
->condition($field, $function, $value, $operator, $langcode);
return $this;
}
/**
* {@inheritdoc}
*/
public function sortAggregate($field, $function, $direction = 'ASC', $langcode = NULL) {
$alias = $this->getAggregationAlias($field, $function);
$this->sortAggregate[$alias] = [
'field' => $field,
'function' => $function,
'direction' => $direction,
'langcode' => $langcode,
];
$this->aggregate($field, $function, $langcode, $alias);
return $this;
}
/**
* {@inheritdoc}
*/
public function groupBy($field, $langcode = NULL) {
$this->groupBy[] = [
'field' => $field,
'langcode' => $langcode,
];
return $this;
}
/**
* Generates an alias for a field and its aggregated function.
*
* @param string $field
* The field name used in the alias.
* @param string $function
* The aggregation function used in the alias.
*
* @return string
* The alias for the field.
*/
protected function getAggregationAlias($field, $function) {
return strtolower($field . '_' . $function);
}
/**
* Gets a list of namespaces of the ancestors of a class.
*
* Returns a list of namespaces that includes the namespace of the
* class, as well as the namespaces of its parent class and ancestors. This
* is useful for locating classes in a hierarchy of namespaces, such as when
* searching for the appropriate query class for an entity type.
*
* @param $object
* An object within a namespace.
*
* @return array
* A list containing the namespace of the class, the namespace of the
* parent of the class and so on and so on.
*/
public static function getNamespaces($object) {
$namespaces = [];
for ($class = get_class($object); $class; $class = get_parent_class($class)) {
$namespaces[] = substr($class, 0, strrpos($class, '\\'));
}
return $namespaces;
}
/**
* Finds a class in a list of namespaces.
*
* Searches in the order of the array, and returns the first one it finds.
*
* @param array $namespaces
* A list of namespaces.
* @param string $short_class_name
* A class name without namespace.
*
* @return string
* The fully qualified name of the class.
*/
public static function getClass(array $namespaces, $short_class_name) {
foreach ($namespaces as $namespace) {
$class = $namespace . '\\' . $short_class_name;
if (class_exists($class)) {
return $class;
}
}
}
/**
* Invoke hooks to allow modules to alter the entity query.
*
* Modules may alter all queries or only those having a particular tag.
* Alteration happens before the query is prepared for execution, so that
* the alterations then get prepared in the same way.
*
* @return $this
* Returns the called object.
*/
protected function alter() : QueryInterface {
$hooks = [
'entity_query',
'entity_query_' . $this->getEntityTypeId(),
];
if ($this->alterTags) {
foreach ($this->alterTags as $tag => $value) {
// Tags and entity type ids may well contain single underscores, and
// 'tag' is a possible entity type id. Therefore use double underscores
// to avoid collisions.
$hooks[] = 'entity_query_tag__' . $tag;
$hooks[] = 'entity_query_tag__' . $this->getEntityTypeId() . '__' . $tag;
}
}
\Drupal::moduleHandler()->alter($hooks, $this);
return $this;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
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 | |
QueryBase::__clone | public | function | Makes sure that the Condition object is cloned as well. | 1 | |
QueryBase::__construct | public | function | Constructs this object. | 3 | |
QueryInterface::execute | public | function | Execute the query. | 5 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.