You are here

LazyForm.php in Lazy-load 8.2

Same filename and directory in other branches
  1. 8.3 src/Form/LazyForm.php
  2. 8 src/Form/LazyForm.php

Namespace

Drupal\lazy\Form

File

src/Form/LazyForm.php
View source
<?php

namespace Drupal\lazy\Form;

use Drupal\Core\Form\ConfigFormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Url;
use Drupal\Core\Messenger\MessengerInterface;

/**
 * Configure Lazy settings for this site.
 */
class LazyForm extends ConfigFormBase {

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

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

  /**
   * Gets enabled filter formats.
   *
   * @param array|null $status
   *   Array of filter-formats and entity bundles.
   */
  protected function getEnabledFiltersAndFields($status) {
    $links = [];
    $anchor_links = [];
    if (!empty($status)) {
      foreach ($status as $name => $bool_value) {
        if ($bool_value && is_string($name)) {
          if (strpos($name, 'filter.format.') === 0 && ($filter_format = substr($name, 14))) {
            $links['filter'][$filter_format] = [
              'uri' => Url::fromRoute('entity.filter_format.edit_form', [
                'filter_format' => $filter_format,
              ])
                ->toString(),
              'title' => $filter_format,
            ];
          }
          elseif (($entity = explode('--', $name)) && count($entity)) {
            list($entity_type, $entity_bundle, $view_mode) = $entity;
            if ($entity_type !== NULL && $entity_bundle !== NULL) {
              $links['field']["{$entity_type}--{$entity_bundle}--{$view_mode}"] = [
                'uri' => Url::fromRoute("entity.entity_view_display.{$entity_type}.view_mode", [
                  ($entity_type === 'paragraph' ? 'paragraphs' : $entity_type) . '_type' => $entity_bundle,
                  'view_mode_name' => $view_mode,
                ])
                  ->toString(),
                'title' => $entity_bundle . " ({$view_mode})",
              ];
            }
          }
        }
      }
      foreach ($links as $key => $link_group) {
        foreach ($link_group as $link) {
          $anchor_links[$key][] = '<a href="' . $link['uri'] . '">' . $link['title'] . '</a>';
        }
      }
    }
    $filter_links_result = isset($anchor_links['filter']) && count($anchor_links['filter']) ? implode(', ', $anchor_links['filter']) : 'none';
    $field_links_result = isset($anchor_links['field']) && count($anchor_links['field']) ? implode(', ', $anchor_links['field']) : 'none';
    $filter_message_type = $filter_links_result === 'none' ? MessengerInterface::TYPE_WARNING : MessengerInterface::TYPE_STATUS;
    $this
      ->messenger()
      ->addMessage($this
      ->t("The <strong>text-formats</strong> have lazy-loading enabled: {$filter_links_result}"), $filter_message_type);
    $field_message_type = $field_links_result === 'none' ? MessengerInterface::TYPE_WARNING : MessengerInterface::TYPE_STATUS;
    $this
      ->messenger()
      ->addMessage($this
      ->t("The <strong>image fields</strong> have lazy-loading enabled: {$field_links_result}"), $field_message_type);
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('lazy.settings');
    $filter_enabled = lazy_is_enabled();
    $this
      ->getEnabledFiltersAndFields($filter_enabled['status']);
    if (!$filter_enabled) {
      $this
        ->messenger()
        ->addWarning($this
        ->t('<p>The %filter filter must be enabled for at least one <a href=":path">text-format</a>, or one entity image:</p>', [
        ':path' => Url::fromRoute('filter.admin_overview')
          ->toString(),
        '%filter' => 'Lazy-load',
      ]));
    }
    $form['settings'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Settings'),
      '#open' => TRUE,
    ];
    $form['settings']['alter_tag'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Select the inline elements to be lazy-loaded via filter.'),
      '#description' => $this
        ->t('Only selected tags will be lazy-loaded in activated text-formats.'),
      '#options' => [
        'img' => $this
          ->t('Enable for images (%img tags)', [
          '%img' => '<img>',
        ]),
        'iframe' => $this
          ->t('Enable for iframes (%iframe tags)', [
          '%iframe' => '<iframe>',
        ]),
      ],
      '#default_value' => $config
        ->get('alter_tag'),
      '#disabled' => !$filter_enabled,
    ];
    $form['settings']['placeholderSrc'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Placeholder image URL'),
      '#default_value' => $config
        ->get('placeholderSrc'),
      '#maxlength' => 255,
      '#required' => TRUE,
    ];
    $form['paths'] = array(
      '#type' => 'details',
      '#title' => $this
        ->t('Disabled pages'),
      '#description' => $this
        ->t('Lazy-loading is disabled for both <em>image fields</em> and <em>inline images/iframes</em> on following pages.'),
      '#open' => FALSE,
    );
    $form['paths']['disabled_paths'] = array(
      '#type' => 'textarea',
      '#title' => $this
        ->t('Pages'),
      '#default_value' => $config
        ->get('disabled_paths'),
      '#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['blazy'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('bLazy configuration'),
      '#description' => $this
        ->t('<p><a href=":url">bLazy</a> is a lightweight lazy loading and multi-serving image script created by Bjoern Klinggaard. See its website for usage details and demos.</p>', [
        ':url' => 'http://dinbror.dk/blog/blazy/',
      ]),
      '#open' => FALSE,
    ];
    $form['blazy']['loadInvisible'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('loadInvisible'),
      '#description' => $this
        ->t('If checked loads invisible (hidden) elements.'),
      '#default_value' => $config
        ->get('loadInvisible'),
      '#return_value' => TRUE,
    ];
    $form['blazy']['offset'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('offset'),
      '#description' => $this
        ->t('The offset controls how early you want the elements to be loaded before they’re visible.'),
      '#default_value' => $config
        ->get('offset'),
      '#min' => 0,
      '#required' => TRUE,
    ];
    $form['blazy']['saveViewportOffsetDelay'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('saveViewportOffsetDelay'),
      '#description' => $this
        ->t('Delay for how often it should call the saveViewportOffset function on resize.'),
      '#default_value' => $config
        ->get('saveViewportOffsetDelay'),
      '#min' => 0,
      '#required' => TRUE,
    ];
    $form['blazy']['validateDelay'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('validateDelay'),
      '#description' => $this
        ->t('Delay for how often it should call the validate function on scroll/resize.'),
      '#default_value' => $config
        ->get('validateDelay'),
      '#min' => 0,
      '#required' => TRUE,
    ];
    $form['blazy']['selector'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Selector class'),
      '#description' => $this
        ->t('Element selector for elements that should lazy load. Do not include a leading period.'),
      '#default_value' => $config
        ->get('selector'),
      '#required' => TRUE,
    ];
    $form['blazy']['skipClass'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('skipClass'),
      '#description' => $this
        ->t('Elements having this class name will be ignored.'),
      '#default_value' => $config
        ->get('skipClass'),
      '#required' => TRUE,
    ];
    $form['blazy']['errorClass'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('errorClass'),
      '#description' => $this
        ->t('The classname an element will get if something goes wrong.'),
      '#default_value' => $config
        ->get('errorClass'),
      '#required' => TRUE,
    ];
    $form['blazy']['successClass'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('successClass'),
      '#description' => $this
        ->t('The classname an element will get when loaded.'),
      '#default_value' => $config
        ->get('successClass'),
      '#required' => TRUE,
    ];
    $form['blazy']['src'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('src'),
      '#description' => $this
        ->t('Attribute where the original element source will be assigned. Do not change this unless attribute is used for other purposes.'),
      '#default_value' => $config
        ->get('src'),
      '#required' => TRUE,
    ];
    $form['clear_cache'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Check the box to clear the cache'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('lazy.settings')
      ->set('alter_tag', $form_state
      ->getValue('alter_tag'))
      ->set('disabled_paths', $form_state
      ->getValue('disabled_paths'))
      ->set('errorClass', $form_state
      ->getValue('errorClass'))
      ->set('loadInvisible', (bool) $form_state
      ->getValue('loadInvisible'))
      ->set('offset', (int) $form_state
      ->getValue('offset'))
      ->set('saveViewportOffsetDelay', (int) $form_state
      ->getValue('saveViewportOffsetDelay'))
      ->set('selector', $form_state
      ->getValue('selector'))
      ->set('skipClass', $form_state
      ->getValue('skipClass'))
      ->set('src', $form_state
      ->getValue('src'))
      ->set('successClass', $form_state
      ->getValue('successClass'))
      ->set('validateDelay', $form_state
      ->getValue('validateDelay'))
      ->set('placeholderSrc', $form_state
      ->getValue('placeholderSrc'))
      ->save();
    parent::submitForm($form, $form_state);
    if ($form_state
      ->getValue('clear_cache')) {
      $this
        ->cacheClear();
    }
  }

  /**
   * Clears all caches, then redirects to the previous page.
   */
  public function cacheClear() {
    drupal_flush_all_caches();
    $this
      ->messenger()
      ->addMessage('Cache cleared.');
  }

}

Classes

Namesort descending Description
LazyForm Configure Lazy settings for this site.