class AnonymousLoginSettings in Anonymous login 8.2

Same name and namespace in other branches

8 src/Form/AnonymousLoginSettings.php \Drupal\anonymous_login\Form\AnonymousLoginSettings

Class AnonymousLoginSettings.

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\anonymous_login\Form\AnonymousLoginSettings

Expanded class hierarchy of AnonymousLoginSettings

1 string reference to 'AnonymousLoginSettings'

anonymous_login.routing.yml in ./anonymous_login.routing.yml: anonymous_login.routing.yml

File

src/Form/AnonymousLoginSettings.php, line 14

Namespace

Drupal\anonymous_login\Form

View source

class AnonymousLoginSettings extends ConfigFormBase {

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

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

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

  /**
   * Constructs a AnonymousLoginSettings object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Path\PathValidatorInterface $path_validator
   *   The path validator service.
   */
  public function __construct(ConfigFactoryInterface $config_factory, PathValidatorInterface $path_validator) {
    parent::__construct($config_factory);
    $this->pathValidator = $path_validator;
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('anonymous_login.settings');
    $form['paths'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Page paths'),
      '#default_value' => $config
        ->get('paths'),
      '#description' => $this
        ->t('Enter a list of page paths that will force anonymous users to login before viewing. After logging in, they will be redirected back to the requested page. Enter each path on a different line. Wildcards (*) can be used. Prefix a path with ~ (tilde) to exclude it from being redirected.'),
    ];
    $form['login_path'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Login page path'),
      '#default_value' => $config
        ->get('login_path') ? $config
        ->get('login_path') : '/user/login',
      '#required' => TRUE,
      '#description' => $this
        ->t('Enter the user login page path of your site.'),
    ];
    $form['message'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Login message'),
      '#default_value' => $config
        ->get('message'),
      '#description' => $this
        ->t('Optionally provide a message that will be shown to users when they are redirected to login.'),
    ];
    return parent::buildForm($form, $form_state);
  }

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

    // Login page path validation.
    $path = $this->pathValidator
      ->getUrlIfValidWithoutAccessCheck($form_state
      ->getValue('login_path'));
    if (!$path) {
      $form_state
        ->setErrorByName('login_path', $this
        ->t('Login page path is invalid. Check it please.'));
    }
    else {

      // Set path without language prefix.
      $form_state
        ->setValue('login_path', '/' . $path
        ->getInternalPath());
    }
  }

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

}

Members

Name	Modifiers	Type	Description	Overrides
AnonymousLoginSettings::$pathValidator	protected	property	The path validator service.
AnonymousLoginSettings::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
AnonymousLoginSettings::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
AnonymousLoginSettings::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
AnonymousLoginSettings::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
AnonymousLoginSettings::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
AnonymousLoginSettings::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
AnonymousLoginSettings::__construct	public	function	Constructs a AnonymousLoginSettings object. 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.
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 AnonymousLoginSettings in Anonymous login 8.2

Hierarchy

File

Namespace

Members

API Navigation