You are here

class WebformTemplatesFilterForm in Webform 6.x

Same name and namespace in other branches
  1. 8.5 modules/webform_templates/src/Form/WebformTemplatesFilterForm.php \Drupal\webform_templates\Form\WebformTemplatesFilterForm

Provides the webform templates filter webform.

Hierarchy

Expanded class hierarchy of WebformTemplatesFilterForm

File

modules/webform_templates/src/Form/WebformTemplatesFilterForm.php, line 13

Namespace

Drupal\webform_templates\Form
View source
class WebformTemplatesFilterForm extends FormBase {
  use WebformEntityStorageTrait;

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

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $instance = parent::create($container);
    $instance->entityTypeManager = $container
      ->get('entity_type.manager');
    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $search = NULL, $category = NULL) {
    $form['#attributes'] = [
      'class' => [
        'webform-filter-form',
      ],
    ];
    $form['filter'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Filter templates'),
      '#open' => TRUE,
      '#attributes' => [
        'class' => [
          'container-inline',
        ],
      ],
    ];
    $form['filter']['search'] = [
      '#type' => 'search',
      '#title' => $this
        ->t('Filter by title, description, or elements'),
      '#title_display' => 'invisible',
      '#placeholder' => $this
        ->t('Filter by title, description, or elements'),
      '#maxlength' => 128,
      '#size' => 40,
      '#autocomplete_route_name' => 'entity.webform.templates.autocomplete',
      '#default_value' => $search,
    ];
    $form['filter']['category'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Category'),
      '#title_display' => 'invisible',
      '#options' => $this
        ->getWebformStorage()
        ->getCategories(TRUE),
      '#empty_option' => $category ? $this
        ->t('Show all webforms') : $this
        ->t('Filter by category'),
      '#default_value' => $category,
    ];
    if (empty($form['filter']['category']['#options'])) {
      $form['filter']['category']['#access'] = FALSE;
    }
    $form['filter']['submit'] = [
      '#type' => 'submit',
      '#button_type' => 'primary',
      '#value' => $this
        ->t('Filter'),
    ];
    if (!empty($search)) {
      $form['filter']['reset'] = [
        '#type' => 'submit',
        '#submit' => [
          '::resetForm',
        ],
        '#value' => $this
          ->t('Reset'),
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $query = [
      'search' => trim($form_state
        ->getValue('search')),
      'category' => trim($form_state
        ->getValue('category')),
    ];
    $form_state
      ->setRedirect($this
      ->getRouteMatch()
      ->getRouteName(), $this
      ->getRouteMatch()
      ->getRawParameters()
      ->all(), [
      'query' => $query,
    ]);
  }

  /**
   * Resets the filter selection.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function resetForm(array &$form, FormStateInterface $form_state) {
    $form_state
      ->setRedirect($this
      ->getRouteMatch()
      ->getRouteName(), $this
      ->getRouteMatch()
      ->getRawParameters()
      ->all());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::config protected function Retrieves a configuration object.
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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 72
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.
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.
WebformEntityStorageTrait::$entityStorageToTypeMappings protected property An associate array of entity type storage aliases.
WebformEntityStorageTrait::$entityTypeManager protected property The entity type manager. 5
WebformEntityStorageTrait::getEntityStorage protected function Retrieves the entity storage.
WebformEntityStorageTrait::getSubmissionStorage protected function Retrieves the webform submission storage.
WebformEntityStorageTrait::getWebformStorage protected function Retrieves the webform storage.
WebformEntityStorageTrait::__get public function Implements the magic __get() method.
WebformTemplatesFilterForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
WebformTemplatesFilterForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
WebformTemplatesFilterForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
WebformTemplatesFilterForm::resetForm public function Resets the filter selection.
WebformTemplatesFilterForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm