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/modules/workspaces/src/EntityQuery/Query.php \Drupal\workspaces\EntityQuery\Query
- 10 core/modules/workspaces/src/EntityQuery/Query.php \Drupal\workspaces\EntityQuery\Query
Alters entity queries to use a workspace revision instead of the default one.
Hierarchy
- class \Drupal\Core\Entity\Query\QueryBase implements QueryInterface
- class \Drupal\Core\Entity\Query\Sql\Query implements QueryInterface
- class \Drupal\workspaces\EntityQuery\Query uses QueryTrait
- class \Drupal\Core\Entity\Query\Sql\Query implements QueryInterface
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/
modules/ workspaces/ src/ EntityQuery/ Query.php, line 10
Namespace
Drupal\workspaces\EntityQueryView source
class Query extends BaseQuery {
use QueryTrait {
prepare as traitPrepare;
}
/**
* {@inheritdoc}
*/
public function prepare() {
$this
->traitPrepare();
// If the prepare() method from the trait decided that we need to alter this
// query, we need to re-define the key fields for fetchAllKeyed() as SQL
// expressions.
if ($this->sqlQuery
->getMetaData('active_workspace_id')) {
$id_field = $this->entityType
->getKey('id');
$revision_field = $this->entityType
->getKey('revision');
// Since the query is against the base table, we have to take into account
// that the revision ID might come from the workspace_association
// relationship, and, as a consequence, the revision ID field is no longer
// a simple SQL field but an expression.
$this->sqlFields = [];
$this->sqlQuery
->addExpression("COALESCE([workspace_association].[target_entity_revision_id], [base_table].[{$revision_field}])", $revision_field);
$this->sqlQuery
->addExpression("[base_table].[{$id_field}]", $id_field);
$this->sqlGroupBy['workspace_association.target_entity_revision_id'] = 'workspace_association.target_entity_revision_id';
$this->sqlGroupBy["base_table.{$id_field}"] = "base_table.{$id_field}";
$this->sqlGroupBy["base_table.{$revision_field}"] = "base_table.{$revision_field}";
}
return $this;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Query:: |
protected | property | ||
Query:: |
protected | property | An array of fields keyed by the field alias. | |
Query:: |
protected | property | An array of strings added as to the group by, keyed by the string to avoid duplicates. | |
Query:: |
protected | property | The build sql select query. | |
Query:: |
protected | property | The Tables object for this query. | |
Query:: |
protected | function | Adds the sort to the build query. | |
Query:: |
protected | function | Compiles the conditions. | |
Query:: |
public | function |
Execute the query. Overrides QueryInterface:: |
|
Query:: |
protected | function | Finish the query by adding fields, GROUP BY and range. | 1 |
Query:: |
protected | function | Constructs a select expression for a given field and language. | |
Query:: |
public | function | Gets the Tables object for this query. | |
Query:: |
public | function |
Prepares the basic query with proper metadata/tags and base fields. Overrides Query:: |
|
Query:: |
protected | function | Executes the query and returns the result. | 1 |
Query:: |
public | function |
Implements the magic __clone method. Overrides QueryBase:: |
|
Query:: |
public | function | Implements the magic __toString method. | |
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:: |
|
QueryTrait:: |
protected | property | The workspace manager. | |
QueryTrait:: |
public | function | ||
QueryTrait:: |
public | function | Aliased as: traitPrepare | |
QueryTrait:: |
public | function | Constructs a Query object. |