You are here

class MixitupFiltersForm in MixItUp Views 8

Same name and namespace in other branches
  1. 8.2 src/Form/MixitupFiltersForm.php \Drupal\mixitup_views\Form\MixitupFiltersForm

Class MixitupFiltersForm.

@package Drupal\mixitup_views\Form

Hierarchy

Expanded class hierarchy of MixitupFiltersForm

1 file declares its use of MixitupFiltersForm
MixitUpFiltersFormTest.php in tests/src/Kernel/MixitUpFiltersFormTest.php

File

src/Form/MixitupFiltersForm.php, line 16

Namespace

Drupal\mixitup_views\Form
View source
class MixitupFiltersForm extends FormBase {

  /**
   * Provides MixItUpFunc Object.
   *
   * @var \Drupal\mixitup_views\MixitupFunc
   */
  protected $mixitupFuncService;

  /**
   * MixitupFiltersForm constructor.
   *
   * @param \Drupal\mixitup_views\MixitupFunc $mixitupFuncService
   *   The MixItUp Func object.
   */
  public function __construct(MixitupFunc $mixitupFuncService) {
    $this->mixitupFuncService = $mixitupFuncService;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('mixitup_views.func_service'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $options = []) {
    $filters = $this->mixitupFuncService
      ->getPopulatedFilters();
    if ($filters !== NULL) {
      foreach ($filters as $vid => $terms) {

        // Show only selected vocabularies.
        if ($options['restrict_vocab'] === 1 && !isset($options['restrict_vocab_ids'][$vid])) {
          unset($filters[$vid]);
          continue;
        }

        // If all nodes have just one term tagged, it doesn't make sense
        // to show a term and clear filters link.
        if (\count($terms) < 2) {
          unset($filters[$vid]);
          continue;
        }
        $vocab = Vocabulary::load($vid);
        if ($vocab !== NULL) {
          $name = $vocab
            ->get('name');
          if (isset($options['filter_type'])) {
            switch ($options['filter_type']) {
              case 'checkboxes':
                $form['filter_' . $vid] = [
                  '#type' => 'checkboxes',
                  '#title' => $name,
                  '#options' => $terms,
                  '#attributes' => [
                    'class' => [
                      'mixitup_views_filter',
                    ],
                    'vid' => $vid,
                  ],
                  '#multiple' => TRUE,
                ];
                break;
              case 'select':
                $form['filter_' . $vid] = [
                  '#type' => 'select',
                  '#title' => $name,
                  '#options' => [
                    '' => $this
                      ->t('All'),
                  ] + $terms,
                  '#attributes' => [
                    'class' => [
                      'mixitup_views_filter',
                    ],
                    'vid' => $vid,
                  ],
                  '#multiple' => FALSE,
                ];
                break;
            }
          }
        }
      }
      if ($filters) {
        $form['reset'] = [
          '#markup' => '<a href="#reset" id="reset">' . $this
            ->t('Reset filters') . '</a>',
        ];
      }
    }
    if (isset($options['use_sort']) && $options['use_sort'] === 1 && isset($options['sorts'])) {
      $form['sort'] = [
        '#theme' => 'mixitup_views_sorting',
        '#sorts' => $options['sorts'],
      ];
    }
    if (isset($options['hide_unchecked_chekboxes']) && $options['hide_unchecked_chekboxes'] === 1) {
      $form['#attached']['drupalSettings']['mixitup_views_filters']['hide_unchecked_checkboxes'] = TRUE;
    }
    else {
      $form['#attached']['drupalSettings']['mixitup_views_filters']['hide_unchecked_checkboxes'] = FALSE;
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $form_state
      ->setCompleteForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::config protected function Retrieves a configuration object.
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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
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.
MixitupFiltersForm::$mixitupFuncService protected property Provides MixItUpFunc Object.
MixitupFiltersForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
MixitupFiltersForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
MixitupFiltersForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
MixitupFiltersForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
MixitupFiltersForm::__construct public function MixitupFiltersForm constructor.
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.