function Query::loadRecords
Same name in other branches
- 9 core/lib/Drupal/Core/Config/Entity/Query/Query.php \Drupal\Core\Config\Entity\Query\Query::loadRecords()
- 8.9.x core/lib/Drupal/Core/Config/Entity/Query/Query.php \Drupal\Core\Config\Entity\Query\Query::loadRecords()
- 11.x core/lib/Drupal/Core/Config/Entity/Query/Query.php \Drupal\Core\Config\Entity\Query\Query::loadRecords()
Loads the config records to examine for the query.
Return value
array Config records keyed by entity IDs.
1 call to Query::loadRecords()
- Query::execute in core/
lib/ Drupal/ Core/ Config/ Entity/ Query/ Query.php - Execute the query.
File
-
core/
lib/ Drupal/ Core/ Config/ Entity/ Query/ Query.php, line 130
Class
- Query
- Defines the entity query for configuration entities.
Namespace
Drupal\Core\Config\Entity\QueryCode
protected function loadRecords() {
$prefix = $this->entityType
->getConfigPrefix() . '.';
$prefix_length = strlen($prefix);
// Search the conditions for restrictions on configuration object names.
$filter_by_names = [];
$has_added_restrictions = 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) {
$has_added_restrictions = TRUE;
$ids = (array) $condition['value'];
$filter_by_names[] = array_map(static function ($id) use ($prefix) {
return $prefix . $id;
}, $ids);
}
elseif (in_array($condition['field'], $lookup_keys)) {
$has_added_restrictions = TRUE;
// If we don't find anything then there are no matches. No point in
// listing anything.
$keys = (array) $condition['value'];
$keys = array_map(static function ($value) use ($condition) {
return $condition['field'] . ':' . $value;
}, $keys);
foreach ($this->getConfigKeyStore()
->getMultiple($keys) as $list) {
$filter_by_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 ($has_added_restrictions !== 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 ($has_added_restrictions === FALSE) {
$filter_by_names = $this->configFactory
->listAll($prefix);
}
else {
$filter_by_names = array_merge(...$filter_by_names);
}
// In case we have an ID condition, try to narrow down the list of config
// objects to load.
if ($id_condition && !empty($filter_by_names)) {
$value = $id_condition['value'];
$filter = NULL;
switch ($id_condition['operator']) {
case '<>':
$filter = static function ($name) use ($value, $prefix_length) {
$id = substr($name, $prefix_length);
return $id !== $value;
};
break;
case 'STARTS_WITH':
$filter = static function ($name) use ($value, $prefix_length) {
$id = substr($name, $prefix_length);
return str_starts_with($id, $value);
};
break;
case 'CONTAINS':
$filter = static function ($name) use ($value, $prefix_length) {
$id = substr($name, $prefix_length);
return str_contains($id, $value);
};
break;
case 'ENDS_WITH':
$filter = static function ($name) use ($value, $prefix_length) {
$id = substr($name, $prefix_length);
return str_ends_with($id, $value);
};
break;
}
if ($filter) {
$filter_by_names = array_filter($filter_by_names, $filter);
}
}
// Load the corresponding records.
$records = [];
foreach ($this->configFactory
->loadMultiple($filter_by_names) as $config) {
$records[substr($config->getName(), $prefix_length)] = $config->get();
}
return $records;
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.