class Query

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

Defines the entity query for configuration entities.

Hierarchy

Expanded class hierarchy of Query

91 string references to 'Query'
AjaxFormCacheTest::testQueryString in core/tests/Drupal/FunctionalJavascriptTests/Ajax/AjaxFormCacheTest.php
Tests AJAX forms on pages with a query string.
BasicTest::testWizardDefaultValues in core/modules/views/tests/src/Functional/Wizard/BasicTest.php
Tests default plugin values are populated from the wizard form.
batch_process in core/includes/form.inc
Processes the batch.
BlockPlaceTest::testPlacingBlocksAdmin in core/modules/block_place/tests/src/Functional/BlockPlaceTest.php
Tests placing blocks as an admin.
CachePluginBase::cacheGet in core/modules/views/src/Plugin/views/cache/CachePluginBase.php
Retrieve data from the cache.

... See full list

File

core/lib/Drupal/Core/Config/Entity/Query/Query.php, line 14

Namespace

Drupal\Core\Config\Entity\Query
View source
class Query extends QueryBase implements QueryInterface {
    
    /**
     * Information about the entity type.
     *
     * @var \Drupal\Core\Config\Entity\ConfigEntityTypeInterface
     */
    protected $entityType;
    
    /**
     * The config factory used by the config entity query.
     *
     * @var \Drupal\Core\Config\ConfigFactoryInterface
     */
    protected $configFactory;
    
    /**
     * The key value factory.
     *
     * @var \Drupal\Core\KeyValueStore\KeyValueFactoryInterface
     */
    protected $keyValueFactory;
    
    /**
     * 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\Config\ConfigFactoryInterface $config_factory
     *   The config factory.
     * @param \Drupal\Core\KeyValueStore\KeyValueFactoryInterface $key_value_factory
     *   The key value factory.
     * @param array $namespaces
     *   List of potential namespaces of the classes belonging to this query.
     */
    public function __construct(EntityTypeInterface $entity_type, $conjunction, ConfigFactoryInterface $config_factory, KeyValueFactoryInterface $key_value_factory, array $namespaces) {
        parent::__construct($entity_type, $conjunction, $namespaces);
        $this->configFactory = $config_factory;
        $this->keyValueFactory = $key_value_factory;
    }
    
    /**
     * Overrides \Drupal\Core\Entity\Query\QueryBase::condition().
     *
     * Additional to the syntax defined in the QueryInterface you can use
     * placeholders (*) to match all keys of an subarray. Let's take the follow
     * yaml file as example:
     * @code
     *  level1:
     *    level2a:
     *      level3: 1
     *    level2b:
     *      level3: 2
     * @endcode
     * Then you can filter out via $query->condition('level1.*.level3', 1).
     */
    public function condition($property, $value = NULL, $operator = NULL, $langcode = NULL) {
        return parent::condition($property, $value, $operator, $langcode);
    }
    
    /**
     * {@inheritdoc}
     */
    public function execute() {
        // Load the relevant config records.
        $configs = $this->loadRecords();
        // Apply conditions.
        $result = $this->condition
            ->compile($configs);
        // 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) {
                $properties = explode('.', $field);
                foreach ($properties as $property) {
                    if (isset($a[$property]) || isset($b[$property])) {
                        $a = isset($a[$property]) ? $a[$property] : NULL;
                        $b = isset($b[$property]) ? $b[$property] : NULL;
                    }
                }
                return $a <= $b ? $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. Config
        // entities have string entity IDs.
        foreach ($result as $key => &$value) {
            $value = (string) $key;
        }
        return $result;
    }
    
    /**
     * Loads the config records to examine for the query.
     *
     * @return array
     *   Config records keyed by entity IDs.
     */
    protected function loadRecords() {
        $prefix = $this->entityType
            ->getConfigPrefix() . '.';
        $prefix_length = strlen($prefix);
        // Search the conditions for restrictions on configuration object names.
        $names = FALSE;
        $id_condition = NULL;
        $id_key = $this->entityType
            ->getKey('id');
        if ($this->condition
            ->getConjunction() == 'AND') {
            $lookup_keys = $this->entityType
                ->getLookupKeys();
            $conditions = $this->condition
                ->conditions();
            foreach ($conditions as $condition_key => $condition) {
                $operator = $condition['operator'] ?: (is_array($condition['value']) ? 'IN' : '=');
                if (is_string($condition['field']) && ($operator == 'IN' || $operator == '=')) {
                    // Special case ID lookups.
                    if ($condition['field'] == $id_key) {
                        $ids = (array) $condition['value'];
                        $names = array_map(function ($id) use ($prefix) {
                            return $prefix . $id;
                        }, $ids);
                    }
                    elseif (in_array($condition['field'], $lookup_keys)) {
                        // If we don't find anything then there are no matches. No point in
                        // listing anything.
                        $names = [];
                        $keys = (array) $condition['value'];
                        $keys = array_map(function ($value) use ($condition) {
                            return $condition['field'] . ':' . $value;
                        }, $keys);
                        foreach ($this->getConfigKeyStore()
                            ->getMultiple($keys) as $list) {
                            $names = array_merge($names, $list);
                        }
                    }
                }
                elseif (!$id_condition && $condition['field'] == $id_key) {
                    $id_condition = $condition;
                }
                // We stop at the first restricting condition on name. In the case where
                // there are additional restricting conditions, results will be
                // eliminated when the conditions are checked on the loaded records.
                if ($names !== FALSE) {
                    // If the condition has been responsible for narrowing the list of
                    // configuration to check there is no point in checking it further.
                    unset($conditions[$condition_key]);
                    break;
                }
            }
        }
        // If no restrictions on IDs were found, we need to parse all records.
        if ($names === FALSE) {
            $names = $this->configFactory
                ->listAll($prefix);
        }
        // In case we have an ID condition, try to narrow down the list of config
        // objects to load.
        if ($id_condition && !empty($names)) {
            $value = $id_condition['value'];
            $filter = NULL;
            switch ($id_condition['operator']) {
                case '<>':
                    $filter = function ($name) use ($value, $prefix_length) {
                        $id = substr($name, $prefix_length);
                        return $id !== $value;
                    };
                    break;
                case 'STARTS_WITH':
                    $filter = function ($name) use ($value, $prefix_length) {
                        $id = substr($name, $prefix_length);
                        return strpos($id, $value) === 0;
                    };
                    break;
                case 'CONTAINS':
                    $filter = function ($name) use ($value, $prefix_length) {
                        $id = substr($name, $prefix_length);
                        return strpos($id, $value) !== FALSE;
                    };
                    break;
                case 'ENDS_WITH':
                    $filter = function ($name) use ($value, $prefix_length) {
                        $id = substr($name, $prefix_length);
                        return strrpos($id, $value) === strlen($id) - strlen($value);
                    };
                    break;
            }
            if ($filter) {
                $names = array_filter($names, $filter);
            }
        }
        // Load the corresponding records.
        $records = [];
        foreach ($this->configFactory
            ->loadMultiple($names) as $config) {
            $records[substr($config->getName(), $prefix_length)] = $config->get();
        }
        return $records;
    }
    
    /**
     * Gets the key value store used to store fast lookups.
     *
     * @return \Drupal\Core\KeyValueStore\KeyValueStoreInterface
     *   The key value store used to store fast lookups.
     */
    protected function getConfigKeyStore() {
        return $this->keyValueFactory
            ->get(QueryFactory::CONFIG_LOOKUP_PREFIX . $this->entityTypeId);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
Query::$configFactory protected property The config factory used by the config entity query.
Query::$entityType protected property Information about the entity type. Overrides QueryBase::$entityType
Query::$keyValueFactory protected property The key value factory.
Query::condition public function Overrides \Drupal\Core\Entity\Query\QueryBase::condition(). Overrides QueryBase::condition
Query::execute public function Execute the query. Overrides QueryInterface::execute
Query::getConfigKeyStore protected function Gets the key value store used to store fast lookups.
Query::loadRecords protected function Loads the config records to examine for the query.
Query::__construct public function Constructs a Query object. 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&#039;t.
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::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

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