class ConfigDevelAutoExportSubscriber in Configuration development 8

ConfigDevelAutoExportSubscriber subscriber for configuration CRUD events.

Hierarchy

• class \Drupal\config_devel\EventSubscriber\ConfigDevelSubscriberBase
  • class \Drupal\config_devel\EventSubscriber\ConfigDevelAutoExportSubscriber implements \Symfony\Component\EventDispatcher\EventSubscriberInterface

1 file declares its use of ConfigDevelAutoExportSubscriber

ConfigDevelAutoExportSubscriberTest.php in tests/src/Unit/ConfigDevelAutoExportSubscriberTest.php

1 string reference to 'ConfigDevelAutoExportSubscriber'

config_devel.services.yml in ./config_devel.services.yml

config_devel.services.yml

1 service uses ConfigDevelAutoExportSubscriber

config_devel.writeback_subscriber in ./config_devel.services.yml

Drupal\config_devel\EventSubscriber\ConfigDevelAutoExportSubscriber

File

src/EventSubscriber/ConfigDevelAutoExportSubscriber.php, line 23

Namespace

Drupal\config_devel\EventSubscriber

class ConfigDevelAutoExportSubscriber extends ConfigDevelSubscriberBase implements EventSubscriberInterface {

  /**
   * The event dispatcher.
   *
   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
   */
  protected $eventDispatcher;

  /**
   * Constructs the ConfigDevelAutoExportSubscriber object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The configuration factory.
   * @param \Drupal\Core\Config\ConfigManagerInterface $config_manager
   *   The configuration manager.
   * @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $event_dispatcher
   *   The event dispatcher.
   */
  public function __construct(ConfigFactoryInterface $config_factory, ConfigManagerInterface $config_manager, EventDispatcherInterface $event_dispatcher) {
    parent::__construct($config_factory, $config_manager);
    $this->configFactory = $config_factory;
    $this->configManager = $config_manager;
    $this->eventDispatcher = $event_dispatcher;
  }

  /**
   * The files to automatically export.
   *
   * @var array
   */
  protected $autoExportFiles;

  /**
   * React to configuration ConfigEvent::SAVE events.
   *
   * @param \Drupal\Core\Config\ConfigCrudEvent $event
   *   The event to process.
   */
  public function onConfigSave(ConfigCrudEvent $event) {
    $this
      ->autoExportConfig($event
      ->getConfig());
  }

  /**
   * React to configuration ConfigEvent::RENAME events.
   *
   * @param \Drupal\Core\Config\ConfigRenameEvent $event
   *   The event to process.
   */
  public function onConfigRename(ConfigRenameEvent $event) {
    $this
      ->autoExportConfig($event
      ->getConfig());
  }

  /**
   * Automatically export configuration.
   *
   * @param Config $config
   *   The config object.
   */
  protected function autoExportConfig(Config $config) {
    $config_name = $config
      ->getName();
    $file_names = array_filter($this
      ->getSettings()
      ->get('auto_export') ?: [], function ($file_name) use ($config_name) {
      return basename($file_name, '.' . FileStorage::getFileExtension()) == $config_name;
    });
    $this
      ->writeBackConfig($config, $file_names);
  }

  /**
   * write configuration back to files.
   *
   * @param \Drupal\Core\Config\Config $config
   *   The config object.
   * @param array $file_names
   *   The file names to which the configuration should be written.
   */
  public function writeBackConfig(Config $config, array $file_names) {

    // TODO: use the config_devel.importer_exporter service.
    if ($file_names) {
      $data = $config
        ->get();
      $config_name = $config
        ->getName();
      unset($data['_core']);
      if ($entity_type_id = $this->configManager
        ->getEntityTypeIdByName($config_name)) {
        unset($data['uuid']);
      }

      // Let everyone else have a change to update the exported data.
      $event = new ConfigDevelSaveEvent($file_names, $data);
      $this->eventDispatcher
        ->dispatch(ConfigDevelEvents::SAVE, $event);
      $data = $event
        ->getData();
      $file_names = $event
        ->getFileNames();
      foreach ($file_names as $file_name) {
        try {
          file_put_contents($file_name, (new InstallStorage())
            ->encode($data));
        } catch (DumpException $e) {

          // Do nothing. What could we do?
        }
      }
    }
  }

  /**
   * Registers the methods in this class that should be listeners.
   *
   * @return array
   *   An array of event listener definitions.
   */
  static function getSubscribedEvents() {
    $events[ConfigEvents::SAVE][] = array(
      'onConfigSave',
      10,
    );
    $events[ConfigEvents::RENAME][] = array(
      'onConfigRename',
      10,
    );
    return $events;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigDevelAutoExportSubscriber::$autoExportFiles	protected	property	The files to automatically export.
ConfigDevelAutoExportSubscriber::$eventDispatcher	protected	property	The event dispatcher.
ConfigDevelAutoExportSubscriber::autoExportConfig	protected	function	Automatically export configuration.
ConfigDevelAutoExportSubscriber::getSubscribedEvents	static	function	Registers the methods in this class that should be listeners.
ConfigDevelAutoExportSubscriber::onConfigRename	public	function	React to configuration ConfigEvent::RENAME events.
ConfigDevelAutoExportSubscriber::onConfigSave	public	function	React to configuration ConfigEvent::SAVE events.
ConfigDevelAutoExportSubscriber::writeBackConfig	public	function	write configuration back to files.
ConfigDevelAutoExportSubscriber::__construct	public	function	Constructs the ConfigDevelAutoExportSubscriber object. Overrides ConfigDevelSubscriberBase::__construct
ConfigDevelSubscriberBase::$configFactory	protected	property	The configuration factory.
ConfigDevelSubscriberBase::$configManager	protected	property	The configuration manager.
ConfigDevelSubscriberBase::getEntityId	protected	function
ConfigDevelSubscriberBase::getSettings	protected	function
ConfigDevelSubscriberBase::getStorage	protected	function