Query.php

Same filename in this branch
  1. 8.9.x core/modules/workspaces/src/EntityQuery/Query.php
  2. 8.9.x core/lib/Drupal/Core/Config/Entity/Query/Query.php
  3. 8.9.x core/lib/Drupal/Core/Database/Query/Query.php
  4. 8.9.x core/lib/Drupal/Core/Entity/Query/Sql/Query.php
  5. 8.9.x core/lib/Drupal/Core/Entity/Query/Null/Query.php
Same filename in other branches
  1. 9 core/modules/workspaces/src/EntityQuery/Query.php
  2. 9 core/lib/Drupal/Core/Config/Entity/Query/Query.php
  3. 9 core/lib/Drupal/Core/Database/Query/Query.php
  4. 9 core/lib/Drupal/Core/Entity/Query/Sql/Query.php
  5. 9 core/lib/Drupal/Core/Entity/Query/Null/Query.php
  6. 9 core/lib/Drupal/Core/Entity/KeyValueStore/Query/Query.php
  7. 10 core/modules/workspaces/src/EntityQuery/Query.php
  8. 10 core/lib/Drupal/Core/Config/Entity/Query/Query.php
  9. 10 core/lib/Drupal/Core/Database/Query/Query.php
  10. 10 core/lib/Drupal/Core/Entity/Query/Sql/Query.php
  11. 10 core/lib/Drupal/Core/Entity/Query/Null/Query.php
  12. 10 core/lib/Drupal/Core/Entity/KeyValueStore/Query/Query.php
  13. 11.x core/modules/workspaces/src/EntityQuery/Query.php
  14. 11.x core/lib/Drupal/Core/Config/Entity/Query/Query.php
  15. 11.x core/lib/Drupal/Core/Database/Query/Query.php
  16. 11.x core/lib/Drupal/Core/Entity/Query/Sql/Query.php
  17. 11.x core/lib/Drupal/Core/Entity/Query/Null/Query.php
  18. 11.x core/lib/Drupal/Core/Entity/KeyValueStore/Query/Query.php

Namespace

Drupal\Core\Entity\KeyValueStore\Query

File

core/lib/Drupal/Core/Entity/KeyValueStore/Query/Query.php

View source
<?php

namespace Drupal\Core\Entity\KeyValueStore\Query;

use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Entity\Query\QueryBase;
use Drupal\Core\KeyValueStore\KeyValueFactoryInterface;

/**
 * Defines the entity query for entities stored in a key value backend.
 */
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);
    }

}

Classes

Title Deprecated Summary
Query Defines the entity query for entities stored in a key value backend.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.