class ConfigEditor in Devel 4.x

Edit config variable form.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\devel\Form\ConfigEditor

1 string reference to 'ConfigEditor'

devel.routing.yml in ./devel.routing.yml

devel.routing.yml

File

src/Form/ConfigEditor.php, line 15

Namespace

Drupal\devel\Form

class ConfigEditor extends FormBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $config_name = '') {
    $config = $this
      ->config($config_name);
    if ($config === FALSE || $config
      ->isNew()) {
      $this
        ->messenger()
        ->addError($this
        ->t('Config @name does not exist in the system.', [
        '@name' => $config_name,
      ]));
      return;
    }
    $data = $config
      ->getOriginal();
    if (empty($data)) {
      $this
        ->messenger()
        ->addWarning($this
        ->t('Config @name exists but has no data.', [
        '@name' => $config_name,
      ]));
      return;
    }
    try {
      $output = Yaml::encode($data);
    } catch (InvalidDataTypeException $e) {
      $this
        ->messenger()
        ->addError($this
        ->t('Invalid data detected for @name : %error', [
        '@name' => $config_name,
        '%error' => $e
          ->getMessage(),
      ]));
      return;
    }
    $form['current'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Current value for %variable', [
        '%variable' => $config_name,
      ]),
      '#attributes' => [
        'class' => [
          'container-inline',
        ],
      ],
    ];
    $form['current']['value'] = [
      '#type' => 'item',
      // phpcs:ignore Drupal.Functions.DiscouragedFunctions
      '#markup' => dpr($output, TRUE),
    ];
    $form['name'] = [
      '#type' => 'value',
      '#value' => $config_name,
    ];
    $form['new'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('New value'),
      '#default_value' => $output,
      '#rows' => 24,
      '#required' => TRUE,
    ];
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save'),
    ];
    $form['actions']['cancel'] = [
      '#type' => 'link',
      '#title' => $this
        ->t('Cancel'),
      '#url' => $this
        ->buildCancelLinkUrl(),
    ];
    $form['actions']['delete'] = [
      '#type' => 'link',
      '#title' => $this
        ->t('Delete'),
      '#url' => Url::fromRoute('devel.config_delete', [
        'config_name' => $config_name,
      ]),
      '#attributes' => [
        'class' => [
          'button',
          'button--danger',
        ],
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $value = $form_state
      ->getValue('new');

    // Try to parse the new provided value.
    try {
      $parsed_value = Yaml::decode($value);

      // Config::setData needs array for the new configuration and
      // a simple string is valid YAML for any reason.
      if (is_array($parsed_value)) {
        $form_state
          ->setValue('parsed_value', $parsed_value);
      }
      else {
        $form_state
          ->setErrorByName('new', $this
          ->t('Invalid input'));
      }
    } catch (InvalidDataTypeException $e) {
      $form_state
        ->setErrorByName('new', $this
        ->t('Invalid input: %error', [
        '%error' => $e
          ->getMessage(),
      ]));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    try {
      $this
        ->configFactory()
        ->getEditable($values['name'])
        ->setData($values['parsed_value'])
        ->save();
      $this
        ->messenger()
        ->addMessage($this
        ->t('Configuration variable %variable was successfully saved.', [
        '%variable' => $values['name'],
      ]));
      $this
        ->logger('devel')
        ->info('Configuration variable %variable was successfully saved.', [
        '%variable' => $values['name'],
      ]);
      $form_state
        ->setRedirectUrl(Url::fromRoute('devel.configs_list'));
    } catch (\Exception $e) {
      $this
        ->messenger()
        ->addError($e
        ->getMessage());
      $this
        ->logger('devel')
        ->error('Error saving configuration variable %variable : %error.', [
        '%variable' => $values['name'],
        '%error' => $e
          ->getMessage(),
      ]);
    }
  }

  /**
   * Builds the cancel link url for the form.
   *
   * @return \Drupal\Core\Url
   *   Cancel url
   */
  private function buildCancelLinkUrl() {
    $query = $this
      ->getRequest()->query;
    if ($query
      ->has('destination')) {
      $options = UrlHelper::parse($query
        ->get('destination'));
      $url = Url::fromUserInput('/' . ltrim($options['path'], '/'), $options);
    }
    else {
      $url = Url::fromRoute('devel.configs_list');
    }
    return $url;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigEditor::buildCancelLinkUrl	private	function	Builds the cancel link url for the form.
ConfigEditor::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
ConfigEditor::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ConfigEditor::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
ConfigEditor::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	3
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
FormBase::configFactory	protected	function	Gets the config factory for this form.	3
FormBase::container	private	function	Returns the service container.
FormBase::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	105
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.
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.
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.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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.	4
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.