You are here

Home » API reference » Pages Restriction Access 8 » PagesRestrictionSettingsForm.php

class PagesRestrictionSettingsForm in Pages Restriction Access 8

Form for configure Pages.

Hierarchy

Expanded class hierarchy of PagesRestrictionSettingsForm

1 string reference to 'PagesRestrictionSettingsForm'
pages_restriction.routing.yml in ./pages_restriction.routing.yml
pages_restriction.routing.yml

File

src/Form/PagesRestrictionSettingsForm.php, line 13

Namespace

Drupal\pages_restriction\Form
View source 
class PagesRestrictionSettingsForm extends ConfigFormBase {

  /**
   * User role object.
   *
   * @var array
   */
  protected $roles;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {

    // Instantiates this form class.
    $instance = parent::create($container);
    $instance->roles = Role::loadMultiple();
    return $instance;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('pages_restriction.settings');
    $form['general_settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('General Settings'),
      '#open' => TRUE,
    ];
    $form['general_settings']['pages_restriction'] = [
      '#title' => $this
        ->t('Pages Restriction'),
      '#type' => 'textarea',
      '#description' => $this
        ->t('Insert values with format: <br><br><b>your-url-restricted|your-target</b> Use one per line.<br><br>E.g.  <b>contact/thank-you-for-contacting-us|contact/send-your-message</b>'),
      '#default_value' => $config
        ->get('pages_restriction'),
    ];
    $form['advanced_settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Advanced Settings'),
      '#open' => FALSE,
    ];
    $keep_parameters = $config
      ->get('keep_parameters');
    $form['advanced_settings']['keep_parameters'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Keep Parameters'),
      '#default_value' => $keep_parameters,
      '#description' => $this
        ->t('Checking this option Gandalf will keep the parameters on URL.'),
    ];
    $option_roles = [];
    foreach ($this->roles as $key => $role) {
      if (!empty($key) && !empty($role
        ->label())) {
        $option_roles[$key] = $role
          ->label();
      }
    }
    if (!empty($option_roles)) {
      $form['advanced_settings']['bypass_role'] = [
        '#type' => 'checkboxes',
        '#options' => $option_roles,
        '#title' => $this
          ->t('Ignore restrictions for the following roles (bypass)'),
        '#default_value' => $config
          ->get('bypass_role'),
      ];
    }
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Submit'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('pages_restriction.settings');
    $pages_restriction = array_values(array_filter(explode(PHP_EOL, str_replace("\r", '', $form_state
      ->getValue('pages_restriction')))));
    $pages_restriction = implode(PHP_EOL, $pages_restriction);
    $config
      ->set('pages_restriction', $pages_restriction);
    $config
      ->set('bypass_role', $form_state
      ->getValue('bypass_role'));
    $config
      ->set('keep_parameters', $form_state
      ->getValue('keep_parameters'));
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 11
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.
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.
PagesRestrictionSettingsForm::$roles protected property User role object.
PagesRestrictionSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
PagesRestrictionSettingsForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
PagesRestrictionSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
PagesRestrictionSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
PagesRestrictionSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
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.