class Query in Drupal 9

The SQL storage entity query class.

Hierarchy

• class \Drupal\Core\Entity\Query\QueryBase implements QueryInterface
  • class \Drupal\Core\Entity\Query\Sql\Query implements QueryInterface

2 files declare their use of Query

Query.php in core/modules/workspaces/src/EntityQuery/Query.php

QueryTest.php in core/tests/Drupal/Tests/Core/Entity/Query/Sql/QueryTest.php

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/Query/Sql/Query.php, line 15

Namespace

Drupal\Core\Entity\Query\Sql

class Query extends QueryBase implements QueryInterface {

  /**
   * The build sql select query.
   *
   * @var \Drupal\Core\Database\Query\SelectInterface
   */
  protected $sqlQuery;

  /**
   * The Tables object for this query.
   *
   * @var \Drupal\Core\Entity\Query\Sql\TablesInterface
   */
  protected $tables;

  /**
   * An array of fields keyed by the field alias.
   *
   * Each entry correlates to the arguments of
   * \Drupal\Core\Database\Query\SelectInterface::addField(), so the first one
   * is the table alias, the second one the field and the last one optional the
   * field alias.
   *
   * @var array
   */
  protected $sqlFields = [];

  /**
   * An array of strings added as to the group by, keyed by the string to avoid
   * duplicates.
   *
   * @var array
   */
  protected $sqlGroupBy = [];

  /**
   * @var \Drupal\Core\Database\Connection
   */
  protected $connection;

  /**
   * Constructs a query 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 \Drupal\Core\Database\Connection $connection
   *   The database connection to run the query against.
   * @param array $namespaces
   *   List of potential namespaces of the classes belonging to this query.
   */
  public function __construct(EntityTypeInterface $entity_type, $conjunction, Connection $connection, array $namespaces) {
    parent::__construct($entity_type, $conjunction, $namespaces);
    $this->connection = $connection;
  }

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

  /**
   * Prepares the basic query with proper metadata/tags and base fields.
   *
   * @return $this
   *   Returns the called object.
   *
   * @throws \Drupal\Core\Entity\Query\QueryException
   *   Thrown if the base table does not exist.
   */
  protected function prepare() {
    if ($this->allRevisions) {
      if (!($base_table = $this->entityType
        ->getRevisionTable())) {
        throw new QueryException("No revision table for " . $this->entityTypeId . ", invalid query.");
      }
    }
    else {
      if (!($base_table = $this->entityType
        ->getBaseTable())) {
        throw new QueryException("No base table for " . $this->entityTypeId . ", invalid query.");
      }
    }
    $simple_query = TRUE;
    if ($this->entityType
      ->getDataTable()) {
      $simple_query = FALSE;
    }
    $this->sqlQuery = $this->connection
      ->select($base_table, 'base_table', [
      'conjunction' => $this->conjunction,
    ]);

    // Reset the tables structure, as it might have been built for a previous
    // execution of this query.
    $this->tables = NULL;
    $this->sqlQuery
      ->addMetaData('entity_type', $this->entityTypeId);
    $id_field = $this->entityType
      ->getKey('id');

    // Add the key field for fetchAllKeyed().
    if (!($revision_field = $this->entityType
      ->getKey('revision'))) {

      // When there is no revision support, the key field is the entity key.
      $this->sqlFields["base_table.{$id_field}"] = [
        'base_table',
        $id_field,
      ];

      // Now add the value column for fetchAllKeyed(). This is always the
      // entity id.
      $this->sqlFields["base_table.{$id_field}" . '_1'] = [
        'base_table',
        $id_field,
      ];
    }
    else {

      // When there is revision support, the key field is the revision key.
      $this->sqlFields["base_table.{$revision_field}"] = [
        'base_table',
        $revision_field,
      ];

      // Now add the value column for fetchAllKeyed(). This is always the
      // entity id.
      $this->sqlFields["base_table.{$id_field}"] = [
        'base_table',
        $id_field,
      ];
    }

    // Add a self-join to the base revision table if we're querying only the
    // latest revisions.
    if ($this->latestRevision && $revision_field) {
      $this->sqlQuery
        ->leftJoin($base_table, 'base_table_2', "[base_table].[{$id_field}] = [base_table_2].[{$id_field}] AND [base_table].[{$revision_field}] < [base_table_2].[{$revision_field}]");
      $this->sqlQuery
        ->isNull("base_table_2.{$id_field}");
    }
    if (is_null($this->accessCheck)) {
      $this->accessCheck = TRUE;
      @trigger_error('Relying on entity queries to check access by default is deprecated in drupal:9.2.0 and an error will be thrown from drupal:10.0.0. Call \\Drupal\\Core\\Entity\\Query\\QueryInterface::accessCheck() with TRUE or FALSE to specify whether access should be checked. See https://www.drupal.org/node/3201242', E_USER_DEPRECATED);
    }
    if ($this->accessCheck) {
      $this->sqlQuery
        ->addTag($this->entityTypeId . '_access');
    }
    $this->sqlQuery
      ->addTag('entity_query');
    $this->sqlQuery
      ->addTag('entity_query_' . $this->entityTypeId);

    // Add further tags added.
    if (isset($this->alterTags)) {
      foreach ($this->alterTags as $tag => $value) {
        $this->sqlQuery
          ->addTag($tag);
      }
    }

    // Add further metadata added.
    if (isset($this->alterMetaData)) {
      foreach ($this->alterMetaData as $key => $value) {
        $this->sqlQuery
          ->addMetaData($key, $value);
      }
    }

    // This now contains first the table containing entity properties and
    // last the entity base table. They might be the same.
    $this->sqlQuery
      ->addMetaData('all_revisions', $this->allRevisions);
    $this->sqlQuery
      ->addMetaData('simple_query', $simple_query);
    return $this;
  }

  /**
   * Compiles the conditions.
   *
   * @return $this
   *   Returns the called object.
   */
  protected function compile() {
    $this->condition
      ->compile($this->sqlQuery);
    return $this;
  }

  /**
   * Adds the sort to the build query.
   *
   * @return $this
   *   Returns the called object.
   */
  protected function addSort() {
    if ($this->count) {
      $this->sort = [];
    }

    // Gather the SQL field aliases first to make sure every field table
    // necessary is added. This might change whether the query is simple or
    // not. See below for more on simple queries.
    $sort = [];
    if ($this->sort) {
      foreach ($this->sort as $key => $data) {
        $sort[$key] = $this
          ->getSqlField($data['field'], $data['langcode']);
      }
    }
    $simple_query = $this
      ->isSimpleQuery();

    // If the query is set up for paging either via pager or by range or a
    // count is requested, then the correct amount of rows returned is
    // important. If the entity has a data table or multiple value fields are
    // involved then each revision might appear in several rows and this needs
    // a significantly more complex query.
    if (!$simple_query) {

      // First, GROUP BY revision id (if it has been added) and entity id.
      // Now each group contains a single revision of an entity.
      foreach ($this->sqlFields as $field) {
        $group_by = "{$field[0]}.{$field[1]}";
        $this->sqlGroupBy[$group_by] = $group_by;
      }
    }

    // Now we know whether this is a simple query or not, actually do the
    // sorting.
    foreach ($sort as $key => $sql_alias) {
      $direction = $this->sort[$key]['direction'];
      if ($simple_query || isset($this->sqlGroupBy[$sql_alias])) {

        // Simple queries, and the grouped columns of complicated queries
        // can be ordered normally, without the aggregation function.
        $this->sqlQuery
          ->orderBy($sql_alias, $direction);
        if (!isset($this->sqlFields[$sql_alias])) {
          $this->sqlFields[$sql_alias] = explode('.', $sql_alias);
        }
      }
      else {

        // Order based on the smallest element of each group if the
        // direction is ascending, or on the largest element of each group
        // if the direction is descending.
        $function = $direction == 'ASC' ? 'min' : 'max';
        $expression = "{$function}({$sql_alias})";
        $expression_alias = $this->sqlQuery
          ->addExpression($expression);
        $this->sqlQuery
          ->orderBy($expression_alias, $direction);
      }
    }
    return $this;
  }

  /**
   * Finish the query by adding fields, GROUP BY and range.
   *
   * @return $this
   *   Returns the called object.
   */
  protected function finish() {
    $this
      ->initializePager();
    if ($this->range) {
      $this->sqlQuery
        ->range($this->range['start'], $this->range['length']);
    }
    foreach ($this->sqlGroupBy as $field) {
      $this->sqlQuery
        ->groupBy($field);
    }
    foreach ($this->sqlFields as $field) {
      $this->sqlQuery
        ->addField($field[0], $field[1], isset($field[2]) ? $field[2] : NULL);
    }
    return $this;
  }

  /**
   * Executes the query and returns the result.
   *
   * @return int|array
   *   Returns the query result as entity IDs.
   */
  protected function result() {
    if ($this->count) {
      return $this->sqlQuery
        ->countQuery()
        ->execute()
        ->fetchField();
    }

    // Return a keyed array of results. The key is either the revision_id or
    // the entity_id depending on whether the entity type supports revisions.
    // The value is always the entity id.
    return $this->sqlQuery
      ->execute()
      ->fetchAllKeyed();
  }

  /**
   * Constructs a select expression for a given field and language.
   *
   * @param string $field
   *   The name of the field being queried.
   * @param string $langcode
   *   The language code of the field.
   *
   * @return string
   *   An expression that will select the given field for the given language in
   *   a SELECT query, such as 'base_table.id'.
   */
  protected function getSqlField($field, $langcode) {
    if (!isset($this->tables)) {
      $this->tables = $this
        ->getTables($this->sqlQuery);
    }
    $base_property = "base_table.{$field}";
    if (isset($this->sqlFields[$base_property])) {
      return $base_property;
    }
    else {
      return $this->tables
        ->addField($field, 'LEFT', $langcode);
    }
  }

  /**
   * Determines whether the query requires GROUP BY and ORDER BY MIN/MAX.
   *
   * @return bool
   */
  protected function isSimpleQuery() {
    return !$this->pager && !$this->range && !$this->count || $this->sqlQuery
      ->getMetaData('simple_query');
  }

  /**
   * Implements the magic __clone method.
   *
   * Reset fields and GROUP BY when cloning.
   */
  public function __clone() {
    parent::__clone();
    $this->sqlFields = [];
    $this->sqlGroupBy = [];
  }

  /**
   * Gets the Tables object for this query.
   *
   * @param \Drupal\Core\Database\Query\SelectInterface $sql_query
   *   The SQL query object being built.
   *
   * @return \Drupal\Core\Entity\Query\Sql\TablesInterface
   *   The object that adds tables and fields to the SQL query object.
   */
  public function getTables(SelectInterface $sql_query) {
    $class = static::getClass($this->namespaces, 'Tables');
    return new $class($sql_query);
  }

  /**
   * Implements the magic __toString method.
   */
  public function __toString() {

    // Clone the query so the prepare and compile doesn't get repeated.
    $clone = clone $this;
    $clone
      ->prepare()
      ->compile()
      ->addSort()
      ->finish();

    // Quote arguments so query is able to be run.
    $quoted = [];
    foreach ($clone->sqlQuery
      ->getArguments() as $key => $value) {
      $quoted[$key] = is_null($value) ? 'NULL' : $this->connection
        ->quote($value);
    }

    // Replace table name brackets.
    $sql = $clone->connection
      ->prefixTables((string) $clone->sqlQuery);
    $sql = $clone->connection
      ->quoteIdentifiers($sql);
    return strtr($sql, $quoted);
  }

}

Members

Name	Modifiers	Type	Description	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 added as to the group by, keyed by the string to avoid duplicates.
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::execute	public	function	Execute the query. Overrides QueryInterface::execute
Query::finish	protected	function	Finish the query by adding fields, GROUP BY and range.	1
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::prepare	protected	function	Prepares the basic query with proper metadata/tags and base fields.	2
Query::result	protected	function	Executes the query and returns the result.	1
Query::__clone	public	function	Implements the magic __clone method. Overrides QueryBase::__clone
Query::__construct	public	function	Constructs a query object. Overrides QueryBase::__construct
Query::__toString	public	function	Implements the magic __toString method.
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::$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::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