You are here

Home » API reference » Page Load Progress 8 » SettingsForm.php

class SettingsForm in Page Load Progress 8

Allows to configure the page_load_progress module.

Hierarchy

Expanded class hierarchy of SettingsForm

1 string reference to 'SettingsForm'
page_load_progress.routing.yml in ./page_load_progress.routing.yml
page_load_progress.routing.yml

File

src/Form/SettingsForm.php, line 11

Namespace

Drupal\page_load_progress\Form
View source 
class SettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $page_load_progress_config = $this
      ->config('page_load_progress.settings');
    $form['page_load_progress_time'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Time to wait before locking the screen'),
      '#description' => $this
        ->t('Enter the time you want to wait before showing the image lock.'),
      '#options' => [
        10 => $this
          ->t('Show immediately'),
        1000 => $this
          ->t('Show after a 1 second delay'),
        3000 => $this
          ->t('Show after a 3 seconds delay'),
        5000 => $this
          ->t('Show after a 5 seconds delay'),
      ],
      '#default_value' => $page_load_progress_config
        ->get('page_load_progress_time'),
    ];
    $form['visibility_conditions'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Visibility conditions'),
      '#open' => TRUE,
    ];
    $form['visibility_conditions']['page_load_progress_request_path'] = [
      '#type' => 'textarea',
      '#default_value' => $page_load_progress_config
        ->get('page_load_progress_request_path'),
      '#description' => $this
        ->t("Specify pages by using their paths. Enter one path per line. The '*' character is a wildcard. An example path is %user-wildcard for every user page. %front is the front page.", [
        '%user-wildcard' => '/user/*',
        '%front' => '<front>',
      ]),
    ];
    $form['visibility_conditions']['page_load_progress_request_path_negate_condition'] = [
      '#type' => 'radios',
      '#default_value' => (int) $page_load_progress_config
        ->get('page_load_progress_request_path_negate_condition'),
      '#options' => [
        $this
          ->t('Show for the listed pages'),
        $this
          ->t('Hide for the listed pages'),
      ],
    ];
    $form['visibility_conditions']['page_load_progress_internal_links'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Use the throbber for internal links'),
      '#description' => $this
        ->t("The throbber won't be triggered on links opened from a modal or when the user is trying to open them in a new tab."),
      '#default_value' => $page_load_progress_config
        ->get('page_load_progress_internal_links'),
    ];
    $form['page_load_progress_esc_key'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Allow ESC key to kill the throbber'),
      '#description' => $this
        ->t('Under some circumstances, you may want to let your user unlock the screen manually by pressing the ESC key.'),
      '#default_value' => $page_load_progress_config
        ->get('page_load_progress_esc_key'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('page_load_progress.settings')
      ->set('page_load_progress_time', $form_state
      ->getValue('page_load_progress_time'))
      ->set('page_load_progress_request_path', $form_state
      ->getValue('page_load_progress_request_path'))
      ->set('page_load_progress_request_path_negate_condition', $form_state
      ->getValue('page_load_progress_request_path_negate_condition'))
      ->set('page_load_progress_internal_links', $form_state
      ->getValue('page_load_progress_internal_links'))
      ->set('page_load_progress_esc_key', $form_state
      ->getValue('page_load_progress_esc_key'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 13
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.
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.
SettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
SettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
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.