You are here

Home » API reference » jQuery UI filter 8.2 » jQueryUiFilterSettingsForm.php

class jQueryUiFilterSettingsForm in jQuery UI filter 8.2

Defines a form that configures jQuery UI filter settings.

Hierarchy

Expanded class hierarchy of jQueryUiFilterSettingsForm

1 string reference to 'jQueryUiFilterSettingsForm'
jquery_ui_filter.routing.yml in ./jquery_ui_filter.routing.yml
jquery_ui_filter.routing.yml

File

src/Form/jQueryUiFilterSettingsForm.php, line 18
Contains \Drupal\jquery_ui_filter\Form\jQueryUiFilterSettingsForm.

Namespace

Drupal\jquery_ui_filter\Form
View source 
class jQueryUiFilterSettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $option_descriptions = [
      'headerTag' => $this
        ->t("<b>headerTag</b>: Header tag for widget's element"),
      'mediaType' => $this
        ->t("<b>mediaType</b>: Media type (all, screen, or print) that widget should be render to. Setting <code>mediaType</code> to <code>screen</code> will limit the display of the widget to the browser and when the page is printed the widget will default back to simple HTML markup. Setting <code>mediaType</code> to <code>all</code> allows the widget to be printed."),
      'scrollTo' => $this
        ->t('<b>scrollTo</b>: Scrolls to bookmarked widget when a page is loaded.'),
      'scrollToDuration' => $this
        ->t('<b>scrollToDuration</b>: The speed at which the page scrolls to a bookmarked widget.'),
      'scrollToOffset' => $this
        ->t("<b>scrollToOffset</b>: The offset from the top of the page that a bookmarked widget scrolls to. Setting to <code>auto</code> will include the page's body top margin and top padding when scrolling to a bookmarked widget."),
    ];
    $config = $this
      ->config('jquery_ui_filter.settings');
    $form['jquery_ui_filter'] = [
      '#tree' => TRUE,
    ];
    foreach (jQueryUiFilter::$widgets as $name => $widget) {
      $t_args = [
        '@name' => $name,
        '@api' => $widget['api'],
      ];
      $form['jquery_ui_filter'][$name] = [
        '#type' => 'details',
        '#title' => $widget['title'],
        '#description' => t('Learn more about <a href="@api">jQuery UI @name options</a>.', $t_args),
        '#open' => TRUE,
      ];
      $options_description = [
        'description' => [
          '#markup' => $this
            ->t('Custom options:'),
        ],
        'options' => [
          '#theme' => 'item_list',
          '#items' => $option_descriptions,
        ],
      ];
      $form['jquery_ui_filter'][$name]['options'] = [
        '#type' => 'textarea',
        '#title' => $this
          ->t('Options (YAML)'),
        '#description' => \Drupal::service('renderer')
          ->render($options_description),
        '#default_value' => Yaml::encode(($config
          ->get($name . '.options') ?: []) + $widget['options']),
        "#rows" => 6,
      ];
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $data = $form_state
      ->getValue('jquery_ui_filter');
    foreach (jQueryUiFilter::$widgets as $name => $label) {
      try {
        Yaml::decode($data[$name]['options']);
      } catch (\Exception $exception) {
        $message = [
          'message' => [
            '#markup' => t('%title is not valid.', [
              '%title' => $label,
            ]),
          ],
          'errors' => [
            '#theme' => 'item_list',
            '#items' => [
              $exception
                ->getMessage(),
            ],
          ],
        ];
        $form_state
          ->setError($form['jquery_ui_filter'][$name]['options'], $message);
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('jquery_ui_filter.settings');
    $data = $form_state
      ->getValue('jquery_ui_filter');
    foreach (jQueryUiFilter::$widgets as $name => $widget) {
      $data[$name]['options'] = (Yaml::decode($data[$name]['options']) ?: []) + $widget['options'];
    }
    $config
      ->setData($data);
    $config
      ->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.
jQueryUiFilterSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
jQueryUiFilterSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
jQueryUiFilterSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
jQueryUiFilterSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
jQueryUiFilterSettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
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.
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.