You are here

Home » API reference » Devel 8.2 » ConfigEditor.php

class ConfigEditor in Devel 8.2

Same name and namespace in other branches
  1. 8.3 src/Form/ConfigEditor.php \Drupal\devel\Form\ConfigEditor
  2. 8 src/Form/ConfigEditor.php \Drupal\devel\Form\ConfigEditor
  3. 4.x src/Form/ConfigEditor.php \Drupal\devel\Form\ConfigEditor

Edit config variable form.

Hierarchy

Expanded class hierarchy of 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
View source 
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.', array(
        '@name' => $config_name,
      )));
      return;
    }
    $data = $config
      ->getOriginal();
    if (empty($data)) {
      $this
        ->messenger()
        ->addWarning($this
        ->t('Config @name exists but has no data.', array(
        '@name' => $config_name,
      )));
      return;
    }
    try {
      $output = Yaml::encode($data);
    } catch (InvalidDataTypeException $e) {
      $this
        ->messenger()
        ->addError($this
        ->t('Invalid data detected for @name : %error', array(
        '@name' => $config_name,
        '%error' => $e
          ->getMessage(),
      )));
      return;
    }
    $form['current'] = array(
      '#type' => 'details',
      '#title' => $this
        ->t('Current value for %variable', array(
        '%variable' => $config_name,
      )),
      '#attributes' => array(
        'class' => array(
          'container-inline',
        ),
      ),
    );
    $form['current']['value'] = array(
      '#type' => 'item',
      '#markup' => dpr($output, TRUE),
    );
    $form['name'] = array(
      '#type' => 'value',
      '#value' => $config_name,
    );
    $form['new'] = array(
      '#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'] = array(
      '#type' => 'link',
      '#title' => $this
        ->t('Cancel'),
      '#url' => $this
        ->buildCancelLinkUrl(),
    );
    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', array(
        '%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.', array(
        '%variable' => $values['name'],
      )));
      $this
        ->logger('devel')
        ->info('Configuration variable %variable was successfully saved.', array(
        '%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.', array(
        '%variable' => $values['name'],
        '%error' => $e
          ->getMessage(),
      ));
    }
  }

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

}

Members

Namesort descending 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 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::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 87
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.
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.