Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Core\Config;
Chris@0: 
Chris@0: use Symfony\Component\EventDispatcher\Event;
Chris@0: 
Chris@0: /**
Chris@0:  * Gets information on all the possible configuration collections.
Chris@0:  */
Chris@0: class ConfigCollectionInfo extends Event {
Chris@0: 
Chris@0:   /**
Chris@0:    * Configuration collection information keyed by collection name.
Chris@0:    *
Chris@0:    * The value is either the configuration factory override that is responsible
Chris@0:    * for the collection or null if there is not one.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $collections = [];
Chris@0: 
Chris@0:   /**
Chris@0:    * Adds a collection to the list of possible collections.
Chris@0:    *
Chris@0:    * @param string $collection
Chris@0:    *   Collection name to add.
Chris@0:    * @param \Drupal\Core\Config\ConfigFactoryOverrideInterface $override_service
Chris@0:    *   (optional) The configuration factory override service responsible for the
Chris@0:    *   collection.
Chris@0:    *
Chris@0:    * @throws \InvalidArgumentException
Chris@0:    *   Exception thrown if $collection is equal to
Chris@0:    *   \Drupal\Core\Config\StorageInterface::DEFAULT_COLLECTION.
Chris@0:    */
Chris@0:   public function addCollection($collection, ConfigFactoryOverrideInterface $override_service = NULL) {
Chris@0:     if ($collection == StorageInterface::DEFAULT_COLLECTION) {
Chris@0:       throw new \InvalidArgumentException('Can not add the default collection to the ConfigCollectionInfo object');
Chris@0:     }
Chris@0:     $this->collections[$collection] = $override_service;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Gets the list of possible collection names.
Chris@0:    *
Chris@0:    * @param bool $include_default
Chris@0:    *   (Optional) Include the default collection. Defaults to TRUE.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   The list of possible collection names.
Chris@0:    */
Chris@0:   public function getCollectionNames($include_default = TRUE) {
Chris@0:     $collection_names = array_keys($this->collections);
Chris@0:     sort($collection_names);
Chris@0:     if ($include_default) {
Chris@0:       array_unshift($collection_names, StorageInterface::DEFAULT_COLLECTION);
Chris@0:     }
Chris@0:     return $collection_names;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Gets the config factory override service responsible for the collection.
Chris@0:    *
Chris@0:    * @param string $collection
Chris@0:    *   The configuration collection.
Chris@0:    *
Chris@0:    * @return \Drupal\Core\Config\ConfigFactoryOverrideInterface|null
Chris@0:    *   The override service responsible for the collection if one exists. NULL
Chris@0:    *   if not.
Chris@0:    */
Chris@0:   public function getOverrideService($collection) {
Chris@0:     return isset($this->collections[$collection]) ? $this->collections[$collection] : NULL;
Chris@0:   }
Chris@0: 
Chris@0: }