You are here

Home » API reference » Redirect after logout 8 » RedirectLogoutSettings.php

class RedirectLogoutSettings in Redirect after logout 8

Class RedirectLogoutSettings.

@package Drupal\redirect_after_logout\Form

Hierarchy

Expanded class hierarchy of RedirectLogoutSettings

1 string reference to 'RedirectLogoutSettings'
redirect_after_logout.routing.yml in ./redirect_after_logout.routing.yml
redirect_after_logout.routing.yml

File

src/Form/RedirectLogoutSettings.php, line 19

Namespace

Drupal\redirect_after_logout\Form
View source 
class RedirectLogoutSettings extends ConfigFormBase {

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandler
   */
  protected $moduleHandler;

  /**
   * The path validator.
   *
   * @var \Drupal\Core\Path\PathValidator
   */
  protected $pathValidator;

  /**
   * {@inheritdoc}
   */
  public function __construct(ModuleHandler $module_handler, PathValidator $pathValidator) {
    $this->moduleHandler = $module_handler;
    $this->pathValidator = $pathValidator;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('module_handler'), $container
      ->get('path.validator'));
  }

  /**
   * Returns a unique string identifying the form.
   *
   * @return string
   *   The unique string identifying the form.
   */
  public function getFormId() {
    return 'redirect_after_logout_settings';
  }

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

  /**
   * Defines the settings form for Redirect After Logout.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return array
   *   Form definition array.
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('redirect_after_logout.settings');
    $form['redirect_after_logout_destination'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Default user redirect destination'),
      '#description' => $this
        ->t('%front is the front page. Tokens are allowed.', [
        '%front' => '<front>',
      ]),
      '#default_value' => $config
        ->get('destination'),
      '#required' => TRUE,
    ];
    $form['redirect_after_logout_message'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Default user redirect message, after logout'),
      '#description' => $this
        ->t('Tokens are allowed.'),
      '#default_value' => $config
        ->get('message'),
    ];
    if ($this->moduleHandler
      ->moduleExists('token')) {

      // Add the token help to a collapsed fieldset at
      // the end of the configuration page.
      $form['token_help'] = [
        '#type' => 'fieldset',
        '#title' => $this
          ->t('Available Tokens List'),
        '#collapsible' => TRUE,
        '#collapsed' => TRUE,
      ];
      $form['token_help']['token_tree'] = [
        '#theme' => 'token_tree_link',
        '#global_types' => TRUE,
      ];
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {

    // Validate redirect destination.
    $value = $form_state
      ->getValue('redirect_after_logout_destination');
    if (UrlHelper::isExternal($value)) {
      return;
    }
    if (($value = $form_state
      ->getValue('redirect_after_logout_destination')) && $value[0] !== '/' && $value !== '<front>') {
      $form_state
        ->setErrorByName('redirect_after_logout_destination', $this
        ->t("The path '%path' has to start with a slash.", [
        '%path' => $form_state
          ->getValue('redirect_after_logout_destination'),
      ]));
    }
    if (!$this->pathValidator
      ->isValid($form_state
      ->getValue('redirect_after_logout_destination'))) {
      $form_state
        ->setErrorByName('redirect_after_logout_destination', $this
        ->t("Either the path '%path' is invalid or you do not have access to it.", [
        '%path' => $form_state
          ->getValue('redirect_after_logout_destination'),
      ]));
    }
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('redirect_after_logout.settings');
    $config
      ->set('destination', $form_state
      ->getValue('redirect_after_logout_destination'));
    $config
      ->set('message', $form_state
      ->getValue('redirect_after_logout_message'));
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
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.
RedirectLogoutSettings::$moduleHandler protected property The module handler.
RedirectLogoutSettings::$pathValidator protected property The path validator.
RedirectLogoutSettings::buildForm public function Defines the settings form for Redirect After Logout. Overrides ConfigFormBase::buildForm
RedirectLogoutSettings::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
RedirectLogoutSettings::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
RedirectLogoutSettings::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
RedirectLogoutSettings::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
RedirectLogoutSettings::validateForm public function Form validation handler. Overrides FormBase::validateForm
RedirectLogoutSettings::__construct public function Constructs a \Drupal\system\ConfigFormBase object. Overrides ConfigFormBase::__construct
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.