class Query in Drupal 9
Same name in this branch
- 9 core/modules/workspaces/src/EntityQuery/Query.php \Drupal\workspaces\EntityQuery\Query
- 9 core/lib/Drupal/Core/Database/Query/Query.php \Drupal\Core\Database\Query\Query
- 9 core/lib/Drupal/Core/Config/Entity/Query/Query.php \Drupal\Core\Config\Entity\Query\Query
- 9 core/lib/Drupal/Core/Entity/KeyValueStore/Query/Query.php \Drupal\Core\Entity\KeyValueStore\Query\Query
- 9 core/lib/Drupal/Core/Entity/Query/Sql/Query.php \Drupal\Core\Entity\Query\Sql\Query
- 9 core/lib/Drupal/Core/Entity/Query/Null/Query.php \Drupal\Core\Entity\Query\Null\Query
Same name and namespace in other branches
- 8 core/lib/Drupal/Core/Entity/KeyValueStore/Query/Query.php \Drupal\Core\Entity\KeyValueStore\Query\Query
- 10 core/lib/Drupal/Core/Entity/KeyValueStore/Query/Query.php \Drupal\Core\Entity\KeyValueStore\Query\Query
Defines the entity query for entities stored in a key value backend.
Hierarchy
- class \Drupal\Core\Entity\Query\QueryBase implements QueryInterface
- class \Drupal\Core\Entity\KeyValueStore\Query\Query
Expanded class hierarchy of Query
5 string references to 'Query'
- PgsqlQueryFactory::get in core/
modules/ workspaces/ src/ EntityQuery/ PgsqlQueryFactory.php - Instantiates an entity query for a given entity type.
- QueryFactory::get in core/
modules/ workspaces/ src/ EntityQuery/ QueryFactory.php - Instantiates an entity query for a given entity type.
- QueryFactory::get in core/
lib/ Drupal/ Core/ Entity/ Query/ Sql/ QueryFactory.php - Instantiates an entity query for a given entity type.
- views.data_types.schema.yml in core/
modules/ views/ config/ schema/ views.data_types.schema.yml - core/modules/views/config/schema/views.data_types.schema.yml
- ViewUI::renderPreview in core/
modules/ views_ui/ src/ ViewUI.php
File
- core/
lib/ Drupal/ Core/ Entity/ KeyValueStore/ Query/ Query.php, line 12
Namespace
Drupal\Core\Entity\KeyValueStore\QueryView source
class Query extends QueryBase {
/**
* The key value factory.
*
* @var \Drupal\Core\KeyValueStore\KeyValueFactoryInterface
*/
protected $keyValueFactory;
/**
* Constructs a new Query.
*
* @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
* The entity type.
* @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.
* @param \Drupal\Core\KeyValueStore\KeyValueFactoryInterface $key_value_factory
* The key value factory.
*/
public function __construct(EntityTypeInterface $entity_type, $conjunction, array $namespaces, KeyValueFactoryInterface $key_value_factory) {
parent::__construct($entity_type, $conjunction, $namespaces);
$this->keyValueFactory = $key_value_factory;
}
/**
* {@inheritdoc}
*/
public function execute() {
// Load the relevant records.
$records = $this->keyValueFactory
->get('entity_storage__' . $this->entityTypeId)
->getAll();
// Apply conditions.
$result = $this->condition
->compile($records);
// Apply sort settings.
foreach ($this->sort as $sort) {
$direction = $sort['direction'] == 'ASC' ? -1 : 1;
$field = $sort['field'];
uasort($result, function ($a, $b) use ($field, $direction) {
return $a[$field] <= $b[$field] ? $direction : -$direction;
});
}
// Let the pager do its work.
$this
->initializePager();
if ($this->range) {
$result = array_slice($result, $this->range['start'], $this->range['length'], TRUE);
}
if ($this->count) {
return count($result);
}
// Create the expected structure of entity_id => entity_id.
$entity_ids = array_keys($result);
return array_combine($entity_ids, $entity_ids);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Query:: |
protected | property | The key value factory. | |
Query:: |
public | function |
Execute the query. Overrides QueryInterface:: |
|
Query:: |
public | function |
Constructs a new Query. Overrides QueryBase:: |
|
QueryBase:: |
protected | property | Whether access check is requested or not. | |
QueryBase:: |
protected | property | The list of aggregate expressions. | |
QueryBase:: |
protected | property | Flag indicating whether to query the current revision or all revisions. | |
QueryBase:: |
protected | property | The query metadata for alter purposes. | |
QueryBase:: |
protected | property | The query tags. | |
QueryBase:: |
protected | property | Conditions. | 1 |
QueryBase:: |
protected | property | Aggregate Conditions. | |
QueryBase:: |
protected | property | TRUE if this is a count query, FALSE if it isn't. | |
QueryBase:: |
protected | property | Information about the entity type. | 1 |
QueryBase:: |
protected | property | The entity type this query runs against. | |
QueryBase:: |
protected | property | The list of columns to group on. | |
QueryBase:: |
protected | property | Flag indicating whether to query the latest revision. | |
QueryBase:: |
protected | property | List of potential namespaces of the classes belonging to this query. | |
QueryBase:: |
protected | property | The query pager data. | |
QueryBase:: |
protected | property | The query range. | |
QueryBase:: |
protected | property | The list of sorts. | |
QueryBase:: |
protected | property | The list of sorts over the aggregate results. | |
QueryBase:: |
public | function |
Enables or disables access checking for this query. Overrides QueryInterface:: |
|
QueryBase:: |
public | function |
Adds additional metadata to the query. Overrides AlterableInterface:: |
|
QueryBase:: |
public | function |
Adds a tag to a query. Overrides AlterableInterface:: |
|
QueryBase:: |
public | function | ||
QueryBase:: |
public | function |
Queries all the revisions. Overrides QueryInterface:: |
|
QueryBase:: |
public | function |
Creates a new group of conditions ANDed together. Overrides QueryInterface:: |
|
QueryBase:: |
public | function |
Add a condition to the query or a condition group. Overrides QueryInterface:: |
1 |
QueryBase:: |
public | function | ||
QueryBase:: |
protected | function | Creates an object holding a group of conditions. | |
QueryBase:: |
public | function |
Makes this a count query. Overrides QueryInterface:: |
|
QueryBase:: |
public | function |
Limits the query to only default revisions. Overrides QueryInterface:: |
|
QueryBase:: |
public | function |
Queries for a non-empty value on a field. Overrides QueryInterface:: |
|
QueryBase:: |
protected | function | Generates an alias for a field and its aggregated function. | |
QueryBase:: |
public static | function | Finds a class in a list of namespaces. | |
QueryBase:: |
public | function |
Gets the ID of the entity type for this query. Overrides QueryInterface:: |
|
QueryBase:: |
public | function |
Retrieves a given piece of metadata. Overrides AlterableInterface:: |
|
QueryBase:: |
public static | function | Gets a list of namespaces of the ancestors of a class. | |
QueryBase:: |
public | function | ||
QueryBase:: |
public | function |
Determines if a given query has all specified tags. Overrides AlterableInterface:: |
|
QueryBase:: |
public | function |
Determines if a given query has any specified tag. Overrides AlterableInterface:: |
|
QueryBase:: |
public | function |
Determines if a given query has a given tag. Overrides AlterableInterface:: |
|
QueryBase:: |
protected | function | Gets the total number of results and initialize a pager for the query. | |
QueryBase:: |
public | function |
Queries the latest revision. Overrides QueryInterface:: |
|
QueryBase:: |
public | function |
Queries for an empty field. Overrides QueryInterface:: |
|
QueryBase:: |
public | function |
Creates a new group of conditions ORed together. Overrides QueryInterface:: |
|
QueryBase:: |
public | function |
Enables a pager for the query. Overrides QueryInterface:: |
|
QueryBase:: |
public | function |
Defines the range of the query. Overrides QueryInterface:: |
|
QueryBase:: |
public | function |
Sorts the result set by a given field. Overrides QueryInterface:: |
|
QueryBase:: |
public | function | ||
QueryBase:: |
public | function |
Enables sortable tables for this query. Overrides QueryInterface:: |
|
QueryBase:: |
public | function | Makes sure that the Condition object is cloned as well. | 1 |