class QuicklinkConfigForm in Quicklink 2.0.x

Same name and namespace in other branches

8 src/Form/QuicklinkConfigForm.php \Drupal\quicklink\Form\QuicklinkConfigForm

Class QuicklinkConfig.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\quicklink\Form\QuicklinkConfigForm

Expanded class hierarchy of QuicklinkConfigForm

1 string reference to 'QuicklinkConfigForm'

quicklink.routing.yml in ./quicklink.routing.yml: quicklink.routing.yml

File

src/Form/QuicklinkConfigForm.php, line 14

Namespace

Drupal\quicklink\Form

View source

class QuicklinkConfigForm extends ConfigFormBase {

  /**
   * Entity Type Manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs a QuicklinkConfigForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(ConfigFactoryInterface $config_factory, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($config_factory);
    $this->entityTypeManager = $entity_type_manager;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'quicklink_config';
  }
  public function quicklink_config_form_validate($form, &$form_state) {
    $parameterFieldsToValidate = array(
      'total_request_limit',
      'concurrency_throttle_limit',
      'viewport_delay',
      'idle_wait_timeout',
    );
    foreach ($parameterFieldsToValidate as $value) {
      $formValue = $form_state['values'][$value];
      if ($formValue !== '' && (!is_numeric($formValue) || intval($formValue) != $formValue || $formValue < 0)) {
        form_set_error($value, t('%name must be a positive integer or zero.', array(
          '%name' => $form['throttle_options'][$value]['#title'],
        )));
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('quicklink.settings');

    // Build form elements.
    $form['settings'] = [
      '#type' => 'vertical_tabs',
      '#attributes' => [
        'class' => [
          'quicklink',
        ],
      ],
    ];

    // Ignore tab.
    $form['ignore'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Prefetch Ignore Settings'),
      '#description' => $this
        ->t('On this tab, specify what Quicklink should not prefetch.'),
      '#group' => 'settings',
    ];
    $form['ignore']['ignore_admin_paths'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Do not prefetch admin paths'),
      '#description' => $this
        ->t('Highly recommended. Ignore administrative paths.'),
      '#default_value' => $config
        ->get('ignore_admin_paths'),
    ];
    $form['ignore']['ignore_ajax_links'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Do not prefetch AJAX links'),
      '#description' => $this
        ->t('Highly recommended. Ignore links that trigger AJAX behavior.'),
      '#default_value' => $config
        ->get('ignore_ajax_links'),
    ];
    $form['ignore']['ignore_hashes'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Ignore paths with hashes (#) in them'),
      '#description' => $this
        ->t('Recommended. Prevents multiple prefetches of the same page.'),
      '#default_value' => $config
        ->get('ignore_hashes'),
    ];
    $form['ignore']['ignore_file_ext'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Ignore paths with file extensions'),
      '#description' => $this
        ->t('Recommended. This will ignore links that end with a file extension.
        It will match paths ending with a period followed by 1-5 characters. Querystrings are supported.'),
      '#default_value' => $config
        ->get('ignore_file_ext'),
    ];
    $form['ignore']['url_patterns_to_ignore'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('URL patterns to ignore (optional)'),
      '#description' => $this
        ->t('Quicklink will not fetch data if the URL contains any of these patterns. Enter one value per line.'),
      '#default_value' => $config
        ->get('url_patterns_to_ignore'),
      '#attributes' => [
        'style' => 'max-width: 600px;',
      ],
    ];
    $form['ignore']['ignore_selectors'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Ignore these selectors (optional)'),
      '#description' => $this
        ->t('Selectors that will not be prefected. Enter one value per line. Example: <code>.footer a</code>'),
      '#default_value' => $config
        ->get('ignore_selectors'),
      '#attributes' => [
        'style' => 'max-width: 600px;',
      ],
    ];

    // Overrides tab.
    $form['overrides'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Optional Overrides'),
      '#description' => $this
        ->t('On this tab, specify various overrides.'),
      '#group' => 'settings',
    ];
    $form['overrides']['selector'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Override parent selector (optional)'),
      '#description' => $this
        ->t('Quicklink will search this CSS selector for URLs to prefetch (ex. <code>.body-inner</code>). Defaults to the whole document.'),
      '#maxlength' => 128,
      '#size' => 128,
      '#default_value' => $config
        ->get('selector'),
      '#attributes' => [
        'style' => 'max-width: 600px;',
      ],
    ];
    $form['overrides']['allowed_domains'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Override allowed domains (optional)'),
      '#description' => $this
        ->t('List of domains to prefetch from. If empty, Quicklink will only prefetch links from the origin domain.
        If you configure this, be sure to input the origin domain. Add <code>true</code> here to allow <em>every</em> origin. Enter one value per line.'),
      '#default_value' => $config
        ->get('allowed_domains'),
      '#attributes' => [
        'style' => 'max-width: 600px;',
      ],
    ];

    // When to Prefetch tab.
    $form['when_load_library'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('When to Load Library'),
      '#description' => $this
        ->t('On this tab, specify when the Quicklink library will be loaded.'),
      '#group' => 'settings',
    ];
    $form['when_load_library']['no_load_when_authenticated'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Prefetch for anonymous users only'),
      '#description' => $this
        ->t('Highly recommended. Quicklink library will not be loaded for authenticated users.'),
      '#default_value' => $config
        ->get('no_load_when_authenticated'),
    ];
    $form['when_load_library']['no_load_when_session'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Do not prefetch during sessions'),
      '#description' => $this
        ->t('Recommended. Disables loading of the Quicklink library when a PHP session has been started. Useful for modules that use sessions (e.g. Drupal Commerce shopping carts).'),
      '#default_value' => $config
        ->get('no_load_when_session'),
    ];
    $options = [];
    $types = $this->entityTypeManager
      ->getStorage('node_type')
      ->loadMultiple();
    foreach ($types as $type) {
      $options[$type
        ->id()] = $type
        ->label();
    }
    $form['when_load_library']['no_load_content_types'] = [
      '#title' => $this
        ->t('Do not load library on these content types:'),
      '#type' => 'checkboxes',
      '#options' => $options,
      '#default_value' => $config
        ->get('no_load_content_types'),
    ];

    // Parameters tab.
    $form['throttle_options'] = [
      '#type' => 'details',
      '#title' => t('Throttle Options'),
      '#description' => t('On this tab, set parameters to adjust how Quicklink loads content.'),
      '#group' => 'settings',
    ];
    $form['throttle_options']['total_request_limit'] = [
      '#type' => 'number',
      '#title' => t('Set request limit'),
      '#description' => t('Enter the total number of requests that can be
        prefetched for a given page. Set to 0 for unlimited. <br><em>Warning</em>: this may not
        work when Concurrency Throttle is also enabled (see
        <a href="https://github.com/GoogleChromeLabs/quicklink/issues/235">https://github.com/GoogleChromeLabs/quicklink/issues/235</a>.'),
      '#maxlength' => 10,
      '#size' => 10,
      '#default_value' => $config
        ->get('total_request_limit', 0),
    ];
    $form['throttle_options']['concurrency_throttle_limit'] = [
      '#type' => 'number',
      '#title' => t('Set concurrency throttle'),
      '#description' => t('Enter a limit for the simultaneous requests that can be made while prefetching. Set to 0 for unlimited.'),
      '#maxlength' => 10,
      '#size' => 10,
      '#default_value' => $config
        ->get('concurrency_throttle_limit', 0),
    ];
    $form['throttle_options']['viewport_delay'] = [
      '#type' => 'number',
      '#title' => t('Viewport Delay'),
      '#field_suffix' => t('ms'),
      '#description' => t('Amount of time each link needs to stay inside the viewport before being prefetched. Default is 0 ms.'),
      '#maxlength' => 10,
      '#size' => 10,
      '#default_value' => $config
        ->get('viewport_delay', 0),
    ];
    $form['throttle_options']['idle_wait_timeout'] = [
      '#type' => 'number',
      '#title' => t('Set idle timeout value'),
      '#field_suffix' => t('ms'),
      '#description' => t('Amount of time the browser must be idle before prefetching, in milliseconds. Default is 2000 ms.'),
      '#maxlength' => 10,
      '#size' => 10,
      '#default_value' => $config
        ->get('idle_wait_timeout', 2000),
    ];

    // Prefetch Paths Only Tab
    $form['paths_only'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Prefetch Paths Only'),
      '#description' => $this
        ->t('On this tab, prefetch paths setting that will override all other settings.'),
      '#group' => 'settings',
    ];
    $form['paths_only']['warning_message'] = [
      '#type' => 'html_tag',
      '#tag' => 'p',
      '#value' => $this
        ->t('Warning: This setting negates all other settings.'),
      '#attributes' => [
        'class' => 'color-warning',
        'style' => 'max-width: 600px; padding: 1rem; font-weight: bold;',
      ],
    ];
    $form['paths_only']['prefetch_only_paths'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Prefetch these paths only (overrides everything else)'),
      '#description' => $this
        ->t('If enabled, this setting will override all other prefetch settings. <strong>Only these paths will be prefetched.</strong> Include the forward slash at the beginning of the path. Enter one value per line.'),
      '#default_value' => $config
        ->get('prefetch_only_paths'),
      '#attributes' => [
        'style' => 'max-width: 600px;',
      ],
    ];

    // Polyfill tab.
    $form['polyfill'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Extended Browser Support'),
      '#description' => $this
        ->t('On this tab, include support of additional browsers via polyfill.'),
      '#group' => 'settings',
    ];
    $form['polyfill']['load_polyfill'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Load <em>Intersection Observer</em> polyfill'),
      '#description' => $this
        ->t('This checkbox will enable loading of necessary polyfills from <a href="https://polyfill.io" target="_blank">polyfill.io</a>. This will enable usage of Quicklink in IE11 and older versions modern browsers.'),
      '#default_value' => $config
        ->get('load_polyfill'),
    ];

    // Debug tab.
    $form['debug'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Debug'),
      '#description' => $this
        ->t('On this tab, enable debug logging.'),
      '#group' => 'settings',
    ];
    $form['debug']['enable_debug_mode'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable debug mode'),
      '#description' => $this
        ->t("Log Quicklink development information to the HTML and JavaScript console."),
      '#default_value' => $config
        ->get('enable_debug_mode'),
    ];
    if ($this
      ->config('quicklink.settings')
      ->get('enable_debug_mode')) {
      $this
        ->messenger()
        ->addWarning($this
        ->t('Quicklink debug mode enabled. Be sure to disable this on production.'));
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $parameterFieldsToValidate = array(
      'total_request_limit',
      'concurrency_throttle_limit',
      'viewport_delay',
      'idle_wait_timeout',
    );
    foreach ($parameterFieldsToValidate as $value) {
      $formValue = $form_state
        ->getValues()[$value];
      if ($formValue !== '' && (!is_numeric($formValue) || intval($formValue) != $formValue || $formValue < 0 || $formValue < '')) {
        $form_state
          ->setErrorByName($value, t('%name must be a positive integer or zero.', array(
          '%name' => $form['throttle_options'][$value]['#title'],
        )));
      }
    }
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $this
      ->config('quicklink.settings')
      ->set('no_load_content_types', array_filter($form_state
      ->getValue('no_load_content_types')))
      ->set('selector', trim($form_state
      ->getValue('selector')))
      ->set('url_patterns_to_ignore', trim($form_state
      ->getValue('url_patterns_to_ignore')))
      ->set('ignore_selectors', trim($form_state
      ->getValue('ignore_selectors')))
      ->set('prefetch_only_paths', trim($form_state
      ->getValue('prefetch_only_paths')))
      ->set('no_load_when_authenticated', $form_state
      ->getValue('no_load_when_authenticated'))
      ->set('no_load_when_session', $form_state
      ->getValue('no_load_when_session'))
      ->set('ignore_admin_paths', $form_state
      ->getValue('ignore_admin_paths'))
      ->set('ignore_ajax_links', $form_state
      ->getValue('ignore_ajax_links'))
      ->set('ignore_hashes', $form_state
      ->getValue('ignore_hashes'))
      ->set('ignore_file_ext', $form_state
      ->getValue('ignore_file_ext'))
      ->set('allowed_domains', trim($form_state
      ->getValue('allowed_domains')))
      ->set('total_request_limit', $form_state
      ->getValue('total_request_limit'))
      ->set('concurrency_throttle_limit', $form_state
      ->getValue('concurrency_throttle_limit'))
      ->set('viewport_delay', $form_state
      ->getValue('viewport_delay'))
      ->set('idle_wait_timeout', $form_state
      ->getValue('idle_wait_timeout'))
      ->set('load_polyfill', $form_state
      ->getValue('load_polyfill'))
      ->set('enable_debug_mode', $form_state
      ->getValue('enable_debug_mode'))
      ->save();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	3
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.	3
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.
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.
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.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
QuicklinkConfigForm::$entityTypeManager	protected	property	Entity Type Manager.
QuicklinkConfigForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
QuicklinkConfigForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
QuicklinkConfigForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
QuicklinkConfigForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
QuicklinkConfigForm::quicklink_config_form_validate	public	function
QuicklinkConfigForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
QuicklinkConfigForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
QuicklinkConfigForm::__construct	public	function	Constructs a QuicklinkConfigForm object. Overrides ConfigFormBase::__construct
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.	4
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.

You are here

class QuicklinkConfigForm in Quicklink 2.0.x

Hierarchy

File

Namespace

Members

API Navigation