class AddIgnoredConfigForm in Config Distro 8

Class AddIgnoredConfigForm.

@package Drupal\config_distro_ignore\Form

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\config_distro_ignore\Form\AddIgnoredConfigForm implements ContainerInjectionInterface

Expanded class hierarchy of AddIgnoredConfigForm

1 string reference to 'AddIgnoredConfigForm'

config_distro_ignore.routing.yml in modules/config_distro_ignore/config_distro_ignore.routing.yml: modules/config_distro_ignore/config_distro_ignore.routing.yml

File

modules/config_distro_ignore/src/Form/AddIgnoredConfigForm.php, line 18

Namespace

Drupal\config_distro_ignore\Form

View source

class AddIgnoredConfigForm extends ConfigFormBase implements ContainerInjectionInterface {

  /**
   * The distro storage to know what collections we have.
   *
   * @var \Drupal\Core\Config\StorageInterface
   */
  protected $distroStorage;

  /**
   * SettingsForm constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory for the parent.
   * @param \Drupal\Core\Config\StorageInterface $distro_storage
   *   The distro storage to know what collections we have.
   */
  public function __construct(ConfigFactoryInterface $config_factory, StorageInterface $distro_storage) {
    parent::__construct($config_factory);
    $this->distroStorage = $distro_storage;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('config_distro.storage.distro'));
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'config_distro_ignore.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'config_distro_ignore_add_config';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $config_name = NULL, $collection = NULL) {
    $form = parent::buildForm($form, $form_state);
    $form['info'] = [
      '#markup' => $this
        ->t('Retain the configuration: @config', [
        '@config' => $config_name,
      ]),
    ];
    $form['name'] = [
      '#type' => 'hidden',
      '#value' => $config_name,
    ];
    $form['collection'] = [
      '#type' => 'hidden',
      '#value' => $collection,
    ];
    $form['type'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('How to retain.'),
      '#default_value' => 'permanent',
      '#options' => [
        'permanent' => $this
          ->t('Permanently'),
        'hash' => $this
          ->t('This specific version'),
      ],
    ];
    $names = $this->distroStorage
      ->getAllCollectionNames();
    $options = [
      'all' => $this
        ->t('All collections'),
      'default' => $this
        ->t('Default collection'),
    ] + array_combine($names, $names);
    $form['apply_collection'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Collection'),
      '#default_value' => 'all',
      '#options' => $options,
    ];
    if ($collection) {
      $form['apply_collection']['#default_value'] = $collection;
    }
    if (empty($names)) {
      $form['apply_collection']['#access'] = FALSE;
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $name = $form_state
      ->getValue('name');
    if (!strlen($name)) {
      throw new \RuntimeException('The config name can not be empty');
    }
    $collection = $form_state
      ->getValue('apply_collection');
    if (!strlen($collection)) {
      throw new \RuntimeException('The collection can not be empty');
    }
    if ($collection == 'all' && $form_state
      ->getValue('type') == 'hash') {

      // When ignoring just the hash but for all collections, we save the hash
      // In the collection keys instead of the all key.
      $hash = DistroIgnoreFilter::hashConfig($this->distroStorage
        ->read($name));
      $this
        ->addNameToConfig('default_collection', $name . DistroIgnoreFilter::HASH_SEPARATOR . $hash);

      // Create hashes for all collections.
      foreach ($this->distroStorage
        ->getAllCollectionNames() as $collectionName) {
        $storage = $this->distroStorage
          ->createCollection($collectionName);
        $hash = DistroIgnoreFilter::hashConfig($storage
          ->read($name));
        $this
          ->addNameToConfig('custom_collections.' . $collectionName, $name . DistroIgnoreFilter::HASH_SEPARATOR . $hash);
      }
    }
    else {

      // Select the config key to use.
      switch ($collection) {
        case 'all':
          $key = 'all_collections';
          break;
        case 'default':
          $key = 'default_collection';
          break;
        default:
          $key = 'custom_collections.' . $collection;
          if ($collection != StorageInterface::DEFAULT_COLLECTION) {

            // Set the distro storage to use the collection so that the hash is
            // later calculated correctly.
            $this->distroStorage = $this->distroStorage
              ->createCollection($collection);
          }
          break;
      }

      // Save the name in the list.
      if ($form_state
        ->getValue('type') == 'hash') {

        // Create the hash of the config as read from the distro storage.
        $hash = DistroIgnoreFilter::hashConfig($this->distroStorage
          ->read($name));
        $this
          ->addNameToConfig($key, $name . DistroIgnoreFilter::HASH_SEPARATOR . $hash);
      }
      else {
        $this
          ->addNameToConfig($key, $name);
      }
    }

    // Redirect back to the page we came from.
    $form_state
      ->setRedirect('config_distro.import');

    // Clear the config_filter plugin cache.
    \Drupal::service('plugin.manager.config_filter')
      ->clearCachedDefinitions();
  }

  /**
   * Add a config name to the list.
   *
   * @param string $key
   *   The config key.
   * @param string $name
   *   The config name to add to the list.
   */
  protected function addNameToConfig($key, $name) {
    $settings = $this
      ->config('config_distro_ignore.settings');
    $data = $settings
      ->get($key);
    $data[] = $name;
    $data = array_filter($data);
    $data = array_unique($data);
    sort($data);
    $settings
      ->set($key, $data);
    $settings
      ->save();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AddIgnoredConfigForm::$distroStorage	protected	property	The distro storage to know what collections we have.
AddIgnoredConfigForm::addNameToConfig	protected	function	Add a config name to the list.
AddIgnoredConfigForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
AddIgnoredConfigForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
AddIgnoredConfigForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
AddIgnoredConfigForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
AddIgnoredConfigForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
AddIgnoredConfigForm::__construct	public	function	SettingsForm constructor. Overrides ConfigFormBase::__construct
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.

You are here

class AddIgnoredConfigForm in Config Distro 8

Hierarchy

File

Namespace

Members

API Navigation