class Query in Drupal 8

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

6 string references to 'Query'

Error::decodeException in core/lib/Drupal/Core/Utility/Error.php

Decodes an exception and retrieves the correct caller.

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

... See full list

File

core/lib/Drupal/Core/Entity/KeyValueStore/Query/Query.php, line 12

Namespace

Drupal\Core\Entity\KeyValueStore\Query

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::$keyValueFactory	protected	property	The key value factory.
Query::execute	public	function	Execute the query. Overrides QueryInterface::execute
Query::__construct	public	function	Constructs a new Query. Overrides QueryBase::__construct
QueryBase::$accessCheck	protected	property	Whether access check is requested or not. Defaults to TRUE.
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	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	Queries the current revision. 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	Overrides QueryInterface::range
QueryBase::sort	public	function	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