You are here

Home » API reference » External Link Pop-up 8 » SettingsForm.php

class SettingsForm in External Link Pop-up 8

Implements the external_link_popup.settings route.

Hierarchy

Expanded class hierarchy of SettingsForm

See also

\Drupal\Core\Form\FormBase

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

File

src/Form/SettingsForm.php, line 13

Namespace

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

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

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

  /**
   * {@inheritdoc}
   */
  protected function config($name = NULL) {
    return parent::config($name ?: 'external_link_popup.settings');
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['whitelist'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Trusted domains (whitelist)'),
      '#default_value' => $this
        ->config()
        ->get('whitelist'),
      '#description' => $this
        ->t('Links to these external domain(s) will work normally, without pop-up warning.') . '<br />' . $this
        ->t('Use base domain name without protocol or "www" prefix. Enter one domain per line.'),
    ];
    $form['show_admin'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show on administration pages too.'),
      '#default_value' => $this
        ->config()
        ->get('show_admin'),
    ];
    $form['width'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Default width'),
      '#attributes' => [
        'class' => [
          'container-inline',
        ],
      ],
      '#tree' => TRUE,
      '#required' => TRUE,
    ];
    $form['width']['value'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Default width'),
      '#title_display' => 'invisible',
      '#min' => 1,
      '#max' => 4096,
      '#default_value' => $this
        ->config()
        ->get('width.value'),
      '#required' => TRUE,
    ];
    $form['width']['units'] = [
      '#type' => 'select',
      '#options' => [
        '%' => '%',
        'px' => 'px',
      ],
      '#default_value' => $this
        ->config()
        ->get('width.units'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
    $whitelist = trim($form_state
      ->getValue('whitelist'));
    if ($whitelist && !preg_match('/^([^\\s\\/\\,+]+[^\\S\\n]*\\n)*([^\\s\\/\\,+]+)$/', $whitelist)) {
      $form_state
        ->setErrorByName('whitelist', $this
        ->t('Please match the requested format.'));
    }
    else {
      $form_state
        ->setValue('whitelist', $whitelist);
    }
    if ($form_state
      ->getValue([
      'width',
      'value',
    ]) && $form_state
      ->getValue([
      'width',
      'units',
    ]) === '%' && $form_state
      ->getValue([
      'width',
      'value',
    ]) > 100) {
      $form_state
        ->setErrorByName('width][value', $this
        ->t('%name must be higher than or equal to %min.', [
        '%name' => $form['width']['#title'],
        '%min' => 100,
      ]));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config()
      ->set('whitelist', $form_state
      ->getValue('whitelist'))
      ->set('show_admin', $form_state
      ->getValue('show_admin'))
      ->set('width', $form_state
      ->getValue('width'))
      ->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
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.
SettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
SettingsForm::config protected function Retrieves a configuration object. Overrides ConfigFormBaseTrait::config
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
SettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
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.