123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251 |
- <?php
- namespace Drupal\config_update;
- use Drupal\Core\Config\ExtensionInstallStorage;
- use Drupal\Core\Config\StorageInterface;
- use Drupal\Core\Entity\EntityTypeManagerInterface;
- use Drupal\Core\Site\Settings;
- use Drupal\Core\Extension\Extension;
- /**
- * Provides methods related to config listing.
- */
- class ConfigLister implements ConfigListInterface {
- /**
- * List of current config entity types, keyed by prefix.
- *
- * This is not set up until ConfigLister::listTypes() has been called.
- *
- * @var string[]
- */
- protected $typesByPrefix = [];
- /**
- * List of current config entity type definitions, keyed by entity type.
- *
- * This is not set up until ConfigLister::listTypes() has been called.
- *
- * @var \Drupal\Core\Entity\EntityTypeInterface[]
- */
- protected $definitions = [];
- /**
- * The entity manager.
- *
- * @var \Drupal\Core\Entity\EntityManagerInterface
- */
- protected $entityManager;
- /**
- * The active config storage.
- *
- * @var \Drupal\Core\Config\StorageInterface
- */
- protected $activeConfigStorage;
- /**
- * The extension config storage.
- *
- * @var \Drupal\Core\Config\ExtensionInstallStorage
- */
- protected $extensionConfigStorage;
- /**
- * The extension config storage for optional config.
- *
- * @var \Drupal\Core\Config\ExtensionInstallStorage
- */
- protected $extensionOptionalConfigStorage;
- /**
- * Constructs a ConfigLister.
- *
- * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_manager
- * The entity manager.
- * @param \Drupal\Core\Config\StorageInterface $active_config_storage
- * The active config storage.
- * @param \Drupal\Core\Config\ExtensionInstallStorage $extension_config_storage
- * The extension config storage.
- * @param \Drupal\Core\Config\ExtensionInstallStorage $extension_optional_config_storage
- * The extension config storage for optional config items.
- */
- public function __construct(EntityTypeManagerInterface $entity_manager, StorageInterface $active_config_storage, ExtensionInstallStorage $extension_config_storage, ExtensionInstallStorage $extension_optional_config_storage) {
- $this->entityManager = $entity_manager;
- $this->activeConfigStorage = $active_config_storage;
- $this->extensionConfigStorage = $extension_config_storage;
- $this->extensionOptionalConfigStorage = $extension_optional_config_storage;
- }
- /**
- * Sets up and returns the entity definitions list.
- */
- public function listTypes() {
- // Return list if it has already been calculated.
- if (count($this->definitions)) {
- return $this->definitions;
- }
- // Calculate and return the list.
- foreach ($this->entityManager->getDefinitions() as $entity_type => $definition) {
- if ($definition->entityClassImplements('Drupal\Core\Config\Entity\ConfigEntityInterface')) {
- $this->definitions[$entity_type] = $definition;
- $prefix = $definition->getConfigPrefix();
- $this->typesByPrefix[$prefix] = $entity_type;
- }
- }
- ksort($this->definitions);
- return $this->definitions;
- }
- /**
- * {@inheritdoc}
- */
- public function getType($name) {
- $definitions = $this->listTypes();
- return isset($definitions[$name]) ? $definitions[$name] : NULL;
- }
- /**
- * {@inheritdoc}
- */
- public function getTypeByPrefix($prefix) {
- $definitions = $this->listTypes();
- return isset($this->typesByPrefix[$prefix]) ? $definitions[$this->typesByPrefix[$prefix]] : NULL;
- }
- /**
- * {@inheritdoc}
- */
- public function getTypeNameByConfigName($name) {
- $definitions = $this->listTypes();
- foreach ($this->typesByPrefix as $prefix => $entity_type) {
- if (strpos($name, $prefix . '.') === 0) {
- return $entity_type;
- }
- }
- return NULL;
- }
- /**
- * {@inheritdoc}
- */
- public function listConfig($list_type, $name) {
- $active_list = [];
- $install_list = [];
- $optional_list = [];
- $definitions = $this->listTypes();
- switch ($list_type) {
- case 'type':
- if ($name == 'system.all') {
- $active_list = $this->activeConfigStorage->listAll();
- $install_list = $this->extensionConfigStorage->listAll();
- $optional_list = $this->extensionOptionalConfigStorage->listAll();
- }
- elseif ($name == 'system.simple') {
- // Listing is done by prefixes, and simple config doesn't have one.
- // So list all and filter out all known prefixes.
- $active_list = $this->omitKnownPrefixes($this->activeConfigStorage->listAll());
- $install_list = $this->omitKnownPrefixes($this->extensionConfigStorage->listAll());
- $optional_list = $this->omitKnownPrefixes($this->extensionOptionalConfigStorage->listAll());
- }
- elseif (isset($this->definitions[$name])) {
- $definition = $this->definitions[$name];
- $prefix = $definition->getConfigPrefix();
- $active_list = $this->activeConfigStorage->listAll($prefix);
- $install_list = $this->extensionConfigStorage->listAll($prefix);
- $optional_list = $this->extensionOptionalConfigStorage->listAll($prefix);
- }
- break;
- case 'profile':
- $name = $this->getProfileName();
- // Intentional fall-through here to the 'module' or 'theme' case.
- case 'module':
- case 'theme':
- $active_list = $this->activeConfigStorage->listAll();
- $install_list = $this->listProvidedItems($list_type, $name);
- $optional_list = $this->listProvidedItems($list_type, $name, TRUE);
- break;
- }
- // This only seems to be a problem in unit tests, where a mock object
- // is returning NULL instead of an empy array for some reason.
- if (!is_array($optional_list)) {
- $optional_list = [];
- }
- return [$active_list, $install_list, $optional_list];
- }
- /**
- * Returns a list of the install storage items for an extension.
- *
- * @param string $type
- * Type of extension ('module', etc.).
- * @param string $name
- * Machine name of extension.
- * @param bool $do_optional
- * FALSE (default) to list config/install items, TRUE to list
- * config/optional items.
- *
- * @return string[]
- * List of config items provided by this extension.
- */
- protected function listProvidedItems($type, $name, $do_optional = FALSE) {
- $pathname = drupal_get_filename($type, $name);
- $component = new Extension(\Drupal::root(), $type, $pathname);
- if ($do_optional) {
- $names = $this->extensionOptionalConfigStorage->getComponentNames([$component]);
- }
- else {
- $names = $this->extensionConfigStorage->getComponentNames([$component]);
- }
- return array_keys($names);
- }
- /**
- * Omits config with known prefixes from a list of config names.
- */
- protected function omitKnownPrefixes($list) {
- $prefixes = array_keys($this->typesByPrefix);
- $list = array_combine($list, $list);
- foreach ($list as $name) {
- foreach ($prefixes as $prefix) {
- if (strpos($name, $prefix . '.') === 0) {
- unset($list[$name]);
- }
- }
- }
- return array_values($list);
- }
- /**
- * Returns the name of the install profile.
- *
- * For backwards compatibility with pre/post 8.3.x, tries to get it from
- * either configuration or settings.
- *
- * @return string
- * The name of the install profile.
- */
- protected function getProfileName() {
- // Code adapted from DrupalKernel::getInstalProfile() in Core.
- // In Core 8.3.x or later, read from config.
- $config = $this->activeConfigStorage->read('core.extension');
- if (!empty($config['profile'])) {
- return $config['profile'];
- }
- else {
- // If system_update_8300() has not yet run, use settings.
- return Settings::get('install_profile');
- }
- }
- }
|