You are here

Home » API reference » Customerror 8 » CustomerrorSettingsForm.php

class CustomerrorSettingsForm in Customerror 8

Provides a form controller for module settings.

Hierarchy

Expanded class hierarchy of CustomerrorSettingsForm

1 string reference to 'CustomerrorSettingsForm'
customerror.routing.yml in ./customerror.routing.yml
customerror.routing.yml

File

src/Form/CustomerrorSettingsForm.php, line 16

Namespace

Drupal\customerror\Form
View source 
class CustomerrorSettingsForm extends ConfigFormBase {
  protected $aliasManager;

  /**
   *
   */
  public function __construct(ConfigFactory $config_factory, AliasManagerInterface $alias_manager) {
    parent::__construct($config_factory);
    $this->aliasManager = $alias_manager;
  }

  /**
   * This method lets us inject the services this class needs.
   *
   * Only inject services that are actually needed. Which services
   * are needed will vary by the controller.
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('path_alias.manager'));
  }

  /**
   * Implements get function for form ID.
   */
  public function getFormId() {
    return 'customerror_settings_form';
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('customerror.settings');
    $form['customerror_form_description'] = [
      '#markup' => $this
        ->t('Enter the error pages that will be seen by your visitors when they get the respective errors. You can enter any HTML text. You can point the users to the FAQ, inform them that you reorganized the site, ask them to report the error, login or register, ...etc.'),
    ];
    $themes = \Drupal::service('theme_handler')
      ->listInfo();
    ksort($themes);
    $theme_options[''] = $this
      ->t('System default');
    foreach ($themes as $key => $theme) {
      $theme_options[$key] = $theme->info['name'];
    }
    $errors = [
      403 => $this
        ->t('access denied'),
      404 => $this
        ->t('requested page not found'),
    ];
    foreach ($errors as $code => $desc) {
      if (\Drupal::config('system.site')
        ->get("page.{$code}") != "/customerror/{$code}") {
        $this
          ->messenger()
          ->addMessage($this
          ->t('Custom error is not configured for @error errors. Please ensure that the default @error page is set to be /customerror/@error on the @link.', [
          '@error' => $code,
          '@link' => Link::createFromRoute($this
            ->t('Site information settings page'), 'system.site_information_settings')
            ->toString(),
        ]), 'error', FALSE);
      }
    }
    foreach ($errors as $code => $desc) {
      $form[$code] = [
        '#type' => 'fieldset',
        '#collapsible' => TRUE,
        '#collapsed' => FALSE,
        '#title' => $this
          ->t('Code @code settings', [
          '@code' => $code,
        ]),
        '#tree' => TRUE,
      ];
      $form[$code]["title"] = [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Title for @code', [
          '@code' => $code,
        ]),
        '#maxlength' => 70,
        '#description' => $this
          ->t('Title of @code error page', [
          '@code' => $code,
        ]),
        '#default_value' => $config
          ->get("{$code}.title"),
      ];
      $form[$code]["body"] = [
        '#type' => 'textarea',
        '#title' => $this
          ->t('Description for @code', [
          '@code' => $code,
        ]),
        '#rows' => 10,
        '#description' => $this
          ->t('This text will be displayed if a @code (@desc) error occurs.', [
          '@code' => $code,
          '@desc' => $desc,
        ]),
        '#default_value' => $config
          ->get("{$code}.body"),
      ];
      $form[$code]["theme"] = [
        '#type' => 'select',
        '#options' => $theme_options,
        '#title' => $this
          ->t('Theme'),
        '#description' => $this
          ->t('Theme to be used on the error page.'),
        '#default_value' => $config
          ->get("{$code}.theme"),
      ];
    }
    $form['redirects'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Redirects'),
      '#open' => FALSE,
    ];
    $form['redirects']['redirect'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Redirect list'),
      '#rows' => 10,
      '#description' => t('These are custom redirect pairs, one per line. Each pair requires a path to match (which is a regular expression) and a destination separated by a space. The keyword <em>&lt;front></em> is allowed as a destination. If you are unfamilar with regular expressions, a simple search string will work, but will match any part of the URl. For example <em>index.html &lt;front></em> will match both <em>http://example.com/index.html &amp; http://example.com/archive/index.html</em>.'),
      '#default_value' => $config
        ->get('redirect'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('customerror.settings');
    $form_state
      ->cleanValues();
    foreach ($form_state
      ->getValues() as $key => $value) {
      $config
        ->set($key, $value);
    }
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
CustomerrorSettingsForm::$aliasManager protected property
CustomerrorSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
CustomerrorSettingsForm::create public static function This method lets us inject the services this class needs. Overrides ConfigFormBase::create
CustomerrorSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
CustomerrorSettingsForm::getFormId public function Implements get function for form ID. Overrides FormInterface::getFormId
CustomerrorSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
CustomerrorSettingsForm::__construct public function Constructs a \Drupal\system\ConfigFormBase object. Overrides ConfigFormBase::__construct
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.