class EntityReferenceFilterViewResult in Views Reference Filter 8

Filter by entity id using items got from the another view..

Plugin annotation

@ViewsFilter("entityreference_filter_view_result");

View source

class EntityReferenceFilterViewResult extends ManyToOne {

  /**
   * Stores the exposed input for this filter.
   *
   * @var mixed
   */
  public $validatedExposedInput = NULL;

  /**
   * Logger channel.
   *
   * @var \Drupal\Core\Logger\LoggerChannel
   */
  protected $loggerChannel;

  /**
   * Language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

  /**
   * Config view storage.
   *
   * @var \Drupal\Core\Config\Entity\ConfigEntityStorageInterface
   */
  protected $viewStorage;

  /**
   * Entity repository.
   *
   * @var \Drupal\Core\Entity\EntityRepositoryInterface
   */
  protected $entityRepository;

  /**
   * Path current stack.
   *
   * @var \Drupal\Core\Path\CurrentPathStack
   */
  protected $pathCurrent;

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

  /**
   * Constructs a EntityReferenceFilterViewResult object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Psr\Log\LoggerInterface $logger_channel
   *   Logger for the channel.
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
   * @param \Drupal\Core\Config\Entity\ConfigEntityStorageInterface $view_storage
   *   View config storage.
   * @param \Drupal\Core\Entity\EntityRepositoryInterface $entity_repository
   *   Entity repository.
   * @param \Drupal\Core\Path\CurrentPathStack $path_current
   *   Path current.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   Entity type manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, LoggerInterface $logger_channel, LanguageManagerInterface $language_manager, ConfigEntityStorageInterface $view_storage, EntityRepositoryInterface $entity_repository, CurrentPathStack $path_current, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->loggerChannel = $logger_channel;
    $this->languageManager = $language_manager;
    $this->viewStorage = $view_storage;
    $this->entityRepository = $entity_repository;
    $this->pathCurrent = $path_current;
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('logger.factory')
      ->get('entityreference_filter'), $container
      ->get('language_manager'), $container
      ->get('entity_type.manager')
      ->getStorage('view'), $container
      ->get('entity.repository'), $container
      ->get('path.current'), $container
      ->get('entity_type.manager'));
  }

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['type'] = [
      'default' => 'select',
    ];
    $options['reference_display'] = [
      'default' => '',
    ];
    $options['reference_arguments'] = [
      'default' => '',
    ];
    $options['hide_empty_filter'] = [
      'default' => TRUE,
    ];
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function hasExtraOptions() {
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function buildExtraOptionsForm(&$form, FormStateInterface $form_state) {

    // @todo autocomplete support
    $form['type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Selection type'),
      '#options' => [
        'select' => $this
          ->t('Dropdown'),
        'textfield' => $this
          ->t('Autocomplete'),
      ],
      '#default_value' => $this->options['type'],
      '#disabled' => TRUE,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildExposeForm(&$form, FormStateInterface $form_state) {
    parent::buildExposeForm($form, $form_state);
    $form['hide_empty_filter'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Hide empty filter'),
      '#description' => $this
        ->t('Hide the exposed widget if the entity list is empty.'),
      '#default_value' => $this->options['hide_empty_filter'],
    ];

    // Hide useless field.
    $form['expose']['reduce']['#access'] = FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function getValueOptions() {
    if (isset($this->valueOptions)) {
      return $this->valueOptions;
    }
    $this->valueOptions = $this
      ->getConfiguredViewsOptions();
    return $this->valueOptions;
  }

  /**
   * Returns options for the selected filter.
   *
   * @return array
   *   Options list.
   */
  public function getConfiguredViewsOptions() {
    $options = [];
    if (empty($this->options['reference_display'])) {
      return [];
    }
    [
      $view_name,
      $display_id,
    ] = explode(':', $this->options['reference_display']);
    $view = Views::getView($view_name);
    if (!$view || !$view
      ->access($display_id)) {
      $this->loggerChannel
        ->warning('The view %view_name is no longer eligible for the filter.', [
        '%view_name' => $view_name,
      ]);
      return $options;
    }
    if ($view instanceof ViewExecutable) {
      $args = $this
        ->getFilterArgs();
      $view
        ->setDisplay($display_id);
      $view
        ->setItemsPerPage(0);

      // Set `entity_reference_options` for the new EntityReference view display implementation.
      $entity_reference_options = [
        'limit' => NULL,
      ];
      $view->displayHandlers
        ->get($display_id)
        ->setOption('entity_reference_options', $entity_reference_options);
      $results = $view
        ->executeDisplay($display_id, $args);
      foreach ($results as $renderable) {
        $entity = $renderable["#row"]->_entity;
        $render = $this
          ->getRenderer();
        $option = $render
          ->renderPlain($renderable);
        $options[$entity
          ->id()] = strip_tags($option);
      }
    }
    return $options;
  }

  /**
   * Get the calculated filter arguments.
   *
   * @return array
   *   Calculated arguments.
   */
  protected function getFilterArgs() {
    $args = [];
    $filters_by_identifier = [];
    $view_args = $this
      ->getViewArgs();
    $view_context_args = $this
      ->getViewContextArgs();
    $reference_arguments = $this->options['reference_arguments'] ?? NULL;
    if (isset($reference_arguments)) {
      $arg_str = trim($reference_arguments);
      if ($arg_str !== '') {
        $args = explode('/', $arg_str);
        foreach ($args as $i => $arg) {
          $arg = trim($arg);
          $first_char = mb_substr($arg, 0, 1);

          // URL argument.
          if ($first_char === '!') {
            $arg_no = (int) mb_substr($arg, 1) - 1;
            if ($arg_no >= 0) {
              $args[$i] = $view_args[$arg_no] ?? NULL;
            }
          }

          // Exposed filter as argument.
          if ($first_char === '[' && mb_substr($arg, -1) === ']') {

            // Collect exposed filters.
            if (empty($filters_by_identifier) && !empty($this->view->filter)) {
              foreach ($this->view->filter as $filter_handler) {
                if (!$filter_handler
                  ->isExposed()) {
                  continue;
                }
                $filters_by_identifier[$filter_handler->options['expose']['identifier']] = $filter_handler;
              }
            }
            $args[$i] = NULL;
            $filter_name = mb_substr($arg, 1, -1);

            // User input.
            $input = $this->view
              ->getExposedInput();
            if (isset($input[$filter_name])) {
              $args[$i] = $input[$filter_name];
            }
            elseif (isset($filters_by_identifier[$filter_name])) {
              $args[$i] = $filters_by_identifier[$filter_name]->value;
            }

            // Glue multiple values.
            if (is_array($args[$i]) && !empty($args[$i])) {
              $args[$i] = implode('+', $args[$i]);
            }
          }

          // Contextual filter as argument.
          if ($first_char === '#' && !empty($view_context_args)) {
            $arg_no = (int) mb_substr($arg, 1) - 1;
            $args[$i] = $view_context_args[$arg_no] ?? NULL;
          }

          // Overwrite empty values to NULL.
          if ($args[$i] === 'All' || $args[$i] === []) {
            $args[$i] = NULL;
          }
        }
      }
    }
    return $args;
  }

  /**
   * Get current view arguments.
   *
   * @return array
   *   View arguments.
   */
  protected function getViewArgs() {
    return $this->view->args;
  }

  /**
   * Get current view contextual arguments.
   *
   * @return array
   *   View contextual arguments.
   */
  protected function getViewContextArgs() {
    $args = [];
    $arguments = $this->view->argument ?? [];
    foreach ($arguments as $handler) {
      $args[] = $handler
        ->getValue();
    }
    return $args;
  }

  /**
   * Get the controlling filters which are set as arguments.
   *
   * @return array
   *   Controlling filters.
   */
  protected function getControllingFilters() {
    $filters = [];
    if (isset($this->options['reference_arguments'])) {
      $arg_str = trim($this->options['reference_arguments']);
      if ($arg_str !== '') {
        $args = explode('/', $arg_str);
        foreach ($args as $arg) {
          $arg = trim($arg);
          $first_char = mb_substr($arg, 0, 1);
          if ($first_char === '[' && mb_substr($arg, -1, 1) === ']') {
            $filter_name = mb_substr($arg, 1, -1);
            $filters[] = $filter_name;
          }
        }
      }
    }
    return $filters;
  }

  /**
   * After build form callback for exposed form with entity reference filters.
   */
  public function afterBuild(array $element, FormStateInterface $form_state) {
    $identifier = $this->options['expose']['identifier'];
    $form_id = $element['#id'];
    $controlling_filters = $this
      ->getControllingFilters();

    // Prevent Firefox from remembering values between page reloads.
    foreach ($controlling_filters as $filter) {
      if (isset($element[$filter])) {
        if (!isset($element[$filter]['#attributes'])) {
          $element[$filter]['#attributes'] = [];
        }
        $element[$filter]['#attributes']['autocomplete'] = 'off';
        foreach (Element::children($element[$filter]) as $child) {
          if (!isset($element[$filter][$child]['#attributes'])) {
            $element[$filter][$child]['#attributes'] = [];
          }
          $element[$filter][$child]['#attributes']['autocomplete'] = 'off';
        }
      }
    }

    /** @var \Drupal\views\Plugin\views\exposed_form\ExposedFormPluginInterface $exposed_plugin **/
    $exposed_plugin = $this->view->display_handler
      ->getPlugin('exposed_form');
    $exposed_plugin_options = $exposed_plugin->options ?? NULL;
    $autosubmit = $exposed_plugin_options['bef']['general']['autosubmit'] ?? FALSE;

    // Send dependent filters settings into drupalSettings.
    if (!$autosubmit && !empty($controlling_filters)) {
      $element['#attached']['drupalSettings']['entityreference_filter'][$form_id]['view'] = [
        'view_name' => $this->view->storage
          ->id(),
        'view_display_id' => $this->view->current_display,
        'view_args' => Html::escape(implode('/', $this
          ->getViewArgs())),
        'view_context_args' => $this
          ->getViewContextArgs(),
        'view_path' => Html::escape($this->pathCurrent
          ->getPath()),
        'view_base_path' => $this->view
          ->getPath(),
        'view_dom_id' => $this->view->dom_id,
        'ajax_path' => Url::fromRoute('entityreference_filter.ajax')
          ->toString(),
      ];
      $element['#attached']['drupalSettings']['entityreference_filter'][$form_id]['dependent_filters_data'][$identifier] = $controlling_filters;
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  protected function valueForm(&$form, FormStateInterface $form_state) {
    $values = $this
      ->getValueOptions();
    $exposed = $form_state
      ->get('exposed');
    $filter_is_required = $this->options['expose']['required'];
    $filter_is_multiple = $this->options['expose']['multiple'];
    $filter_empty_hide = $this->options['hide_empty_filter'];

    // Autocomplete widget.
    if ($this->options['type'] === 'textfield') {

      // @todo autocomplete widget support
    }
    else {
      $default_value = (array) $this->value;

      // Run time.
      if ($exposed) {
        $identifier = $this->options['expose']['identifier'];
        $user_input = $form_state
          ->getUserInput();

        // Dynamic dependent filters.
        if (isset($this->options['reference_arguments']) && strpos($this->options['reference_arguments'], '[') !== FALSE) {

          // This filter depends on other filters dynamically,
          // store data for configuring drupalSettings and attach the library.
          $form['#attached'] = [
            'library' => [
              'entityreference_filter/entityreference_filter',
            ],
          ];

          // Build js settings on every form rebuild.
          $form['#after_build'][] = [
            $this,
            'afterBuild',
          ];
        }

        // Delete irrelevant default values.
        $default_value = $user_input[$identifier] ?? [];
        if (!is_array($default_value)) {
          $default_value = [
            $default_value,
          ];
        }
        $default_value = array_intersect($default_value, array_keys($values));

        // Single filter selection, recalculate default value.
        if (!$filter_is_multiple) {
          if (!$filter_is_required && empty($default_value)) {
            $default_value = 'All';
          }
          elseif (empty($default_value)) {
            $keys = array_keys($values);
            $default_value = array_shift($keys);
          }
          else {
            $copy = $default_value;
            $default_value = array_shift($copy);
          }
        }
      }
      $form['value'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Reference filter'),
        '#multiple' => TRUE,
        '#options' => $values,
        '#size' => min(9, count($values)),
        '#default_value' => $default_value,
      ];

      // Set user input.
      if ($exposed && isset($identifier)) {
        $user_input[$identifier] = $default_value;
        $form_state
          ->setUserInput($user_input);
      }
    }

    // Hide filter with empty options.
    if (empty($values) && $exposed && $filter_empty_hide) {
      $form['value']['#prefix'] = '<div class="hidden">';
      $form['value']['#suffix'] = '</div>';
    }

    // Views UI. Options form.
    if (!$exposed) {
      $options = [];
      $views_ids = [];

      // Don't show value selection widget.
      $form['value']['#access'] = FALSE;
      $filter_base_table = !empty($this->definition['filter_base_table']) ? $this->definition['filter_base_table'] : NULL;

      // Filter views that list the entity type we want and group the separate
      // displays by view.
      if ($filter_base_table) {
        $views_ids = $this->viewStorage
          ->getQuery()
          ->condition('status', TRUE)
          ->condition('display.*.display_plugin', 'entity_reference')
          ->condition('base_table', $filter_base_table)
          ->execute();
      }
      foreach ($this->viewStorage
        ->loadMultiple($views_ids) as $view) {

        // Check each display to see if it meets the criteria and it is enabled.
        foreach ($view
          ->get('display') as $display_id => $display) {

          // If the key doesn't exist, enabled is assumed.
          $enabled = !empty($display['display_options']['enabled']) || !array_key_exists('enabled', $display['display_options']);
          if ($enabled && $display['display_plugin'] === 'entity_reference') {
            $options[$view
              ->id() . ':' . $display_id] = $view
              ->label() . ' - ' . $display['display_title'];
          }
        }
      }
      $show_reference_arguments_field = TRUE;
      $description = '<p>' . $this
        ->t('Choose the view and display that select the entities that can be referenced. Only views with a display of type "Entity Reference" are eligible.') . '</p>';
      if (empty($options)) {
        $options = [
          $this->options['reference_display'] => $this
            ->t('None'),
        ] + $options;
        $warning = '<em>' . $this
          ->t('No views to use. At first, create a view display type "Entity Reference" with the same entity type as default filter values.') . '</em>';
        $description = $warning;
        $show_reference_arguments_field = FALSE;
      }
      $form['reference_display'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('View used to select the entities'),
        '#required' => TRUE,
        '#options' => $options,
        '#default_value' => $this->options['reference_display'],
        '#description' => $description,
      ];
      if (empty($this->options['reference_display'])) {
        $form['reference_display']['#description'] .= '<p>' . $this
          ->t('Entity list will be available after saving this setting.') . '</p>';
      }
      $form['reference_arguments'] = [
        '#type' => 'textfield',
        '#size' => 50,
        '#maxlength' => 256,
        '#title' => $this
          ->t('Arguments for the view'),
        '#default_value' => $this->options['reference_arguments'],
        '#description' => $this
          ->t('Define arguments to send them to the selected entity reference view, they are received as contextual filter values in the same order.
        Format is arg1/arg2/...argN starting from position 1. Possible arguments types are:') . '<br>' . $this
          ->t('!n - argument number n of the view dynamic URL argument %') . '<br>' . $this
          ->t('#n - argument number n of the contextual filter value') . '<br>' . $this
          ->t('[filter_identifier] - `Filter identifier` of the named exposed filter') . '<br>' . $this
          ->t('and other strings are passed as is.'),
        '#access' => $show_reference_arguments_field,
      ];
      $this->helper
        ->buildOptionsForm($form, $form_state);
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function valueValidate($form, FormStateInterface $form_state) {

    // We only validate if they've chosen the text field style.
    if ($this->options['type'] !== 'textfield') {
      return;
    }

    // @todo autocomplete validate
  }

  /**
   * {@inheritdoc}
   */
  protected function valueSubmit($form, FormStateInterface $form_state) {

    // Set values as NULL.
    $form_state
      ->setValue([
      'options',
      'value',
    ], NULL);
  }

  /**
   * {@inheritdoc}
   */
  public function validateExposed(&$form, FormStateInterface $form_state) {
    $exposed = $this
      ->isExposed();
    $identifier = $this->options['expose']['identifier'];
    if (!$exposed || !$identifier) {
      return;
    }

    // Except autocomplete widget.
    // We only validate if they've chosen the text field style.
    if ($this->options['type'] !== 'textfield') {
      if ($form_state
        ->getValue($identifier) !== 'All') {
        $this->validatedExposedInput = (array) $form_state
          ->getValue($identifier);
      }
      return;
    }

    // Autocomplete widget.
    // @todo autocomplete widget support
  }

  /**
   * {@inheritdoc}
   */
  public function acceptExposedInput($input) {
    $exposed = $this
      ->isExposed();
    $filter_is_required = $this->options['expose']['required'];
    if (!$exposed) {
      return TRUE;
    }

    // We need to know the operator, which is normally set in
    // \Drupal\views\Plugin\views\filter\FilterPluginBase::acceptExposedInput(),
    // before we actually call the parent version of ourselves.
    if (!empty($this->options['expose']['use_operator']) && !empty($this->options['expose']['operator_id']) && isset($input[$this->options['expose']['operator_id']])) {
      $this->operator = $input[$this->options['expose']['operator_id']];
    }

    // If view is an attachment and is inheriting exposed filters, then assume
    // exposed input has already been validated.
    if (!empty($this->view->is_attachment) && $this->view->display_handler
      ->usesExposed()) {
      $this->validatedExposedInput = (array) $this->view->exposed_raw_input[$this->options['expose']['identifier']];
    }

    // If we're checking for EMPTY or NOT, we don't need any input, and we can
    // say that our input conditions are met by just having the right operator.
    if ($this->operator === 'empty' || $this->operator === 'not empty') {
      return TRUE;
    }

    // If it's non-required and there's no value don't bother filtering.
    if (!$filter_is_required && empty($this->validatedExposedInput)) {
      return FALSE;
    }

    // If we have previously validated input, override values and rewrite query.
    $rewrite_query = parent::acceptExposedInput($input);
    if ($rewrite_query && isset($this->validatedExposedInput)) {
      $this->value = $this->validatedExposedInput;
    }
    return $rewrite_query;
  }

  /**
   * {@inheritdoc}
   */
  public function query() {
    $exposed = $this
      ->isExposed();

    // Recalculate values if the filter is not exposed.
    if (!$exposed) {
      $options = $this
        ->getValueOptions();

      // If there are no filter options then add zero value item to ensure
      // there are no results.
      $values = !empty($options) ? array_keys($options) : [
        '0',
      ];
      $this->value = $values;
    }
    parent::query();
  }

  /**
   * Detects if the filter is exposed in the form.
   *
   * @return bool
   *   Exposed state.
   */
  public function isExposed() {
    return !empty($this->options['exposed']) ? TRUE : FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function adminSummary() {
    $this
      ->getValueOptions();
    return parent::adminSummary();
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {

    // @todo check cache contexts
    $contexts = parent::getCacheContexts();
    $contexts[] = 'user';
    return $contexts;
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheTags() {

    // Adds entityreference view base entity as cache tag.
    $reference_display = $this->options['reference_display'] ?? FALSE;
    if ($reference_display) {
      [
        $view_name,
      ] = explode(':', $reference_display);

      /** @var \Drupal\views\Entity\View $config */
      $config = $this->viewStorage
        ->load($view_name);
      if ($config && $config instanceof View) {
        $definitions = $this->entityTypeManager
          ->getDefinitions();
        foreach ($definitions as $definition) {
          $base_table_view = $config
            ->get('base_table');
          if ($definition instanceof ContentEntityTypeInterface) {
            $base_table_entity = $definition
              ->getDataTable();
            if (!$base_table_entity) {
              $base_table_entity = $definition
                ->getBaseTable();
            }
            if ($base_table_entity === $base_table_view) {
              return $definition
                ->getListCacheTags();
            }
          }
        }
      }
    }
    return parent::getCacheTags();
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    $dependencies = parent::calculateDependencies();

    // Add referenced view config as dependency.
    $reference_display = $this->options['reference_display'] ?? FALSE;
    if ($reference_display) {
      [
        $view_name,
      ] = explode(':', $reference_display);

      /** @var \Drupal\views\Entity\View $config */
      $config = $this->viewStorage
        ->load($view_name);
      if (empty($config) || !$config instanceof View) {
        return $dependencies;
      }
      $dependencies[$config
        ->getConfigDependencyKey()][] = $config
        ->getConfigDependencyName();
    }
    return $dependencies;
  }

}

Members

Name	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
EntityReferenceFilterViewResult::$entityRepository	protected	property	Entity repository.
EntityReferenceFilterViewResult::$entityTypeManager	protected	property	Entity Type manager.
EntityReferenceFilterViewResult::$languageManager	protected	property	Language manager.
EntityReferenceFilterViewResult::$loggerChannel	protected	property	Logger channel.
EntityReferenceFilterViewResult::$pathCurrent	protected	property	Path current stack.
EntityReferenceFilterViewResult::$validatedExposedInput	public	property	Stores the exposed input for this filter.
EntityReferenceFilterViewResult::$viewStorage	protected	property	Config view storage.
EntityReferenceFilterViewResult::acceptExposedInput	public	function	Determines if the input from a filter should change the generated query. Overrides InOperator::acceptExposedInput
EntityReferenceFilterViewResult::adminSummary	public	function	Display the filter on the administrative summary Overrides InOperator::adminSummary
EntityReferenceFilterViewResult::afterBuild	public	function	After build form callback for exposed form with entity reference filters.
EntityReferenceFilterViewResult::buildExposeForm	public	function	Options form subform for exposed filter options. Overrides InOperator::buildExposeForm
EntityReferenceFilterViewResult::buildExtraOptionsForm	public	function	Provide a form for setting options. Overrides HandlerBase::buildExtraOptionsForm
EntityReferenceFilterViewResult::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides HandlerBase::calculateDependencies
EntityReferenceFilterViewResult::create	public static	function	Creates an instance of the plugin. Overrides PluginBase::create
EntityReferenceFilterViewResult::defineOptions	protected	function	Information about options for all kinds of purposes will be held here. Overrides ManyToOne::defineOptions
EntityReferenceFilterViewResult::getCacheContexts	public	function	The cache contexts associated with this object. Overrides FilterPluginBase::getCacheContexts
EntityReferenceFilterViewResult::getCacheTags	public	function	The cache tags associated with this object. Overrides FilterPluginBase::getCacheTags
EntityReferenceFilterViewResult::getConfiguredViewsOptions	public	function	Returns options for the selected filter.
EntityReferenceFilterViewResult::getControllingFilters	protected	function	Get the controlling filters which are set as arguments.
EntityReferenceFilterViewResult::getFilterArgs	protected	function	Get the calculated filter arguments.
EntityReferenceFilterViewResult::getValueOptions	public	function	Child classes should be used to override this function and set the 'value options', unless 'options callback' is defined as a valid function or static public method to generate these values. Overrides InOperator::getValueOptions
EntityReferenceFilterViewResult::getViewArgs	protected	function	Get current view arguments.
EntityReferenceFilterViewResult::getViewContextArgs	protected	function	Get current view contextual arguments.
EntityReferenceFilterViewResult::hasExtraOptions	public	function	If a handler has 'extra options' it will get a little settings widget and another form called extra_options. Overrides HandlerBase::hasExtraOptions
EntityReferenceFilterViewResult::isExposed	public	function	Detects if the filter is exposed in the form. Overrides HandlerBase::isExposed
EntityReferenceFilterViewResult::query	public	function	Add this filter to the query. Overrides InOperator::query
EntityReferenceFilterViewResult::validateExposed	public	function	Validate the exposed handler form Overrides HandlerBase::validateExposed
EntityReferenceFilterViewResult::valueForm	protected	function	Options form subform for setting options. Overrides ManyToOne::valueForm
EntityReferenceFilterViewResult::valueSubmit	protected	function	Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. Overrides InOperator::valueSubmit
EntityReferenceFilterViewResult::valueValidate	protected	function	Validate the options form. Overrides FilterPluginBase::valueValidate
EntityReferenceFilterViewResult::__construct	public	function	Constructs a EntityReferenceFilterViewResult object. Overrides HandlerBase::__construct
FilterPluginBase::$alwaysMultiple	protected	property	Disable the possibility to force a single value.	6
FilterPluginBase::$always_required	public	property	Disable the possibility to allow a exposed input to be optional.
FilterPluginBase::$group_info	public	property	Contains the information of the selected item in a grouped filter.
FilterPluginBase::$no_operator	public	property	Disable the possibility to use operators.	1
FilterPluginBase::$operator	public	property	Contains the operator which is used on the query.
FilterPluginBase::$value	public	property	Contains the actual value of the field,either configured in the views ui or entered in the exposed filters.
FilterPluginBase::addGroupForm	public	function	Add a new group to the exposed filter groups.
FilterPluginBase::arrayFilterZero	protected static	function	Filter by no empty values, though allow the use of (string) "0".
FilterPluginBase::buildExposedFiltersGroupForm	protected	function	Build the form to let users create the group of exposed filters. This form is displayed when users click on button 'Build group'
FilterPluginBase::buildExposedForm	public	function	Render our chunk of the exposed filter form when selecting Overrides HandlerBase::buildExposedForm
FilterPluginBase::buildGroupForm	public	function	Displays the Build Group form.
FilterPluginBase::buildGroupOptions	protected	function	Provide default options for exposed filters.
FilterPluginBase::buildGroupSubmit	protected	function	Save new group items, re-enumerates and remove groups marked to delete.
FilterPluginBase::buildGroupValidate	protected	function	Validate the build group options form.
FilterPluginBase::buildOptionsForm	public	function	Provide the basic form which calls through to subforms. If overridden, it is best to call through to the parent, or to at least make sure all of the functions in this form are called. Overrides HandlerBase::buildOptionsForm	2
FilterPluginBase::canBuildGroup	protected	function	Determine if a filter can be converted into a group. Only exposed filters with operators available can be converted into groups.
FilterPluginBase::canExpose	public	function	Determine if a filter can be exposed. Overrides HandlerBase::canExpose	5
FilterPluginBase::canGroup	public	function	Can this filter be used in OR groups?	1
FilterPluginBase::convertExposedInput	public	function	Transform the input from a grouped filter into a standard filter.
FilterPluginBase::exposedInfo	public	function	Tell the renderer about our exposed form. This only needs to be overridden for particularly complex forms. And maybe not even then. Overrides HandlerBase::exposedInfo
FilterPluginBase::exposedTranslate	protected	function	Make some translations to a form item to make it more suitable to exposing.
FilterPluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
FilterPluginBase::groupForm	public	function	Build a form containing a group of operator \| values to apply as a single filter.
FilterPluginBase::groupMultipleExposedInput	public	function	Returns the options available for a grouped filter that users checkboxes as widget, and therefore has to be applied several times, one per item selected.
FilterPluginBase::hasValidGroupedValue	protected	function	Determines if the given grouped filter entry has a valid value.	1
FilterPluginBase::isAGroup	public	function	Returns TRUE if the exposed filter works like a grouped filter. Overrides HandlerBase::isAGroup
FilterPluginBase::multipleExposedInput	public	function	Returns TRUE if users can select multiple groups items of a grouped exposed filter. Overrides HandlerBase::multipleExposedInput
FilterPluginBase::operatorForm	protected	function	Options form subform for setting the operator.	6
FilterPluginBase::operatorSubmit	public	function	Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.
FilterPluginBase::operatorValidate	protected	function	Validate the operator form.
FilterPluginBase::prepareFilterSelectOptions	protected	function	Sanitizes the HTML select element's options.
FilterPluginBase::showBuildGroupButton	protected	function	Shortcut to display the build_group/hide button.
FilterPluginBase::showBuildGroupForm	public	function	Shortcut to display the exposed options form.
FilterPluginBase::showExposeButton	public	function	Shortcut to display the expose/hide button. Overrides HandlerBase::showExposeButton
FilterPluginBase::showOperatorForm	public	function	Shortcut to display the operator form.
FilterPluginBase::showValueForm	protected	function	Shortcut to display the value form.
FilterPluginBase::storeExposedInput	public	function	If set to remember exposed input in the session, store it there. Overrides HandlerBase::storeExposedInput
FilterPluginBase::storeGroupInput	public	function	If set to remember exposed input in the session, store it there. This function is similar to storeExposedInput but modified to work properly when the filter is a group.
FilterPluginBase::submitOptionsForm	public	function	Simple submit handler Overrides PluginBase::submitOptionsForm
FilterPluginBase::trustedCallbacks	public static	function	Lists the trusted callbacks provided by the implementing class. Overrides PluginBase::trustedCallbacks
FilterPluginBase::validateExposeForm	public	function	Validate the options form. Overrides HandlerBase::validateExposeForm
FilterPluginBase::validateIdentifier	protected	function	Validates a filter identifier.
FilterPluginBase::validateOptionsForm	public	function	Simple validate handler Overrides PluginBase::validateOptionsForm	1
HandlerBase::$field	public	property	With field you can override the realField if the real field is not set.
HandlerBase::$moduleHandler	protected	property	The module handler.	3
HandlerBase::$query	public	property	Where the $query object will reside:	7
HandlerBase::$realField	public	property	The actual field in the database table, maybe different on other kind of query plugins/special handlers.
HandlerBase::$relationship	public	property	The relationship used for this field.
HandlerBase::$table	public	property	The table this handler is attached to.
HandlerBase::$tableAlias	public	property	The alias of the table of this handler which is used in the query.
HandlerBase::$viewsData	protected	property	The views data service.
HandlerBase::access	public	function	Check whether given user has access to this handler. Overrides ViewsHandlerInterface::access	4
HandlerBase::adminLabel	public	function	Return a string representing this handler's name in the UI. Overrides ViewsHandlerInterface::adminLabel	4
HandlerBase::breakString	public static	function	Breaks x,y,z and x+y+z into an array. Overrides ViewsHandlerInterface::breakString
HandlerBase::broken	public	function	Determines if the handler is considered 'broken', meaning it's a placeholder used when a handler can't be found. Overrides ViewsHandlerInterface::broken
HandlerBase::buildGroupByForm	public	function	Provide a form for aggregation settings.	1
HandlerBase::caseTransform	protected	function	Transform a string by a certain method.
HandlerBase::defineExtraOptions	public	function	Provide defaults for the handler.
HandlerBase::displayExposedForm	public	function	Displays the Expose form.
HandlerBase::getDateField	public	function	Creates cross-database SQL dates.	2
HandlerBase::getDateFormat	public	function	Creates cross-database SQL date formatting.	2
HandlerBase::getEntityType	public	function	Determines the entity type used by this handler. Overrides ViewsHandlerInterface::getEntityType
HandlerBase::getField	public	function	Shortcut to get a handler's raw field value. Overrides ViewsHandlerInterface::getField
HandlerBase::getJoin	public	function	Get the join object that should be used for this handler. Overrides ViewsHandlerInterface::getJoin
HandlerBase::getModuleHandler	protected	function	Gets the module handler.
HandlerBase::getTableJoin	public static	function	Fetches a handler to join one table to a primary table from the data cache. Overrides ViewsHandlerInterface::getTableJoin
HandlerBase::getViewsData	protected	function	Gets views data service.
HandlerBase::placeholder	protected	function	Provides a unique placeholders for handlers.
HandlerBase::postExecute	public	function	Run after the view is executed, before the result is cached. Overrides ViewsHandlerInterface::postExecute
HandlerBase::preQuery	public	function	Run before the view is built. Overrides ViewsHandlerInterface::preQuery	2
HandlerBase::sanitizeValue	public	function	Sanitize the value for output. Overrides ViewsHandlerInterface::sanitizeValue
HandlerBase::setModuleHandler	public	function	Sets the module handler.
HandlerBase::setRelationship	public	function	Called just prior to query(), this lets a handler set up any relationship it needs. Overrides ViewsHandlerInterface::setRelationship
HandlerBase::setViewsData	public	function
HandlerBase::showExposeForm	public	function	Shortcut to display the exposed options form. Overrides ViewsHandlerInterface::showExposeForm
HandlerBase::submitExposed	public	function	Submit the exposed handler form
HandlerBase::submitExposeForm	public	function	Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data.
HandlerBase::submitExtraOptionsForm	public	function	Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.
HandlerBase::submitFormCalculateOptions	public	function	Calculates options stored on the handler	1
HandlerBase::submitGroupByForm	public	function	Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.	1
HandlerBase::submitTemporaryForm	public	function	A submit handler that is used for storing temporary items when using multi-step changes, such as ajax requests.
HandlerBase::usesGroupBy	public	function	Provides the handler some groupby.	13
HandlerBase::validateExtraOptionsForm	public	function	Validate the options form.
InOperator::$valueOptions	protected	property	Stores all operations which are available on the form.
InOperator::$valueTitle	protected	property	The filter title.
InOperator::defaultExposeOptions	public	function	Provide default options for exposed filters. Overrides FilterPluginBase::defaultExposeOptions
InOperator::opEmpty	protected	function
InOperator::operatorOptions	public	function	Build strings from the operators() for 'select' options Overrides FilterPluginBase::operatorOptions	1
InOperator::operatorValues	protected	function
InOperator::opSimple	protected	function		1
InOperator::reduceValueOptions	public	function	When using exposed filters, we may be required to reduce the set.
InOperator::validate	public	function	Validate that the plugin is correct and can be saved. Overrides FilterPluginBase::validate
ManyToOne::$helper	public	property	Stores the Helper object which handles the many_to_one complexity.
ManyToOne::$valueFormType	protected	property	Overrides InOperator::$valueFormType
ManyToOne::ensureMyTable	public	function	Override ensureMyTable so we can control how this joins in. The operator actually has influence over joining. Overrides HandlerBase::ensureMyTable
ManyToOne::init	public	function	Overrides \Drupal\views\Plugin\views\HandlerBase::init(). Overrides InOperator::init	2
ManyToOne::operators	public	function	This kind of construct makes it relatively easy for a child class to add or remove functionality by overriding this function and adding/removing items from this array. Overrides InOperator::operators	1
ManyToOne::opHelper	protected	function
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$definition	public	property	Plugins's definition
PluginBase::$displayHandler	public	property	The display object this plugin is for.
PluginBase::$options	public	property	Options for this plugin will be held here.
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::$renderer	protected	property	Stores the render API renderer.	3
PluginBase::$usesOptions	protected	property	Denotes whether the plugin has an additional options form.	8
PluginBase::$view	public	property	The top object of a view.	1
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy	public	function	Clears a plugin. Overrides ViewsPluginInterface::destroy	2
PluginBase::doFilterByDefinedOptions	protected	function	Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions	public	function	Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens	public	function	Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::getProvider	public	function	Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer	protected	function	Returns the render API renderer.	1
PluginBase::globalTokenForm	public	function	Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace	public	function	Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY		constant	Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED		constant	Include negotiated languages when listing languages.
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::listLanguages	protected	function	Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle	public	function	Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup	public static	function	Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData	public static	function	Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::queryLanguageSubstitutions	public static	function	Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults	protected	function	Fills up the options of the plugin with defaults.
PluginBase::summaryTitle	public	function	Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle	6
PluginBase::themeFunctions	public	function	Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions	1
PluginBase::unpackOptions	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions	public	function	Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions	8
PluginBase::viewsTokenReplace	protected	function	Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin.	1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT		constant	Query string to indicate the site default language.
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.
TrustedCallbackInterface::THROW_EXCEPTION		constant	Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION		constant	Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING		constant	Untrusted callbacks trigger E_USER_WARNING errors.

You are here

class EntityReferenceFilterViewResult in Views Reference Filter 8

Plugin annotation

Hierarchy

See also

File

Namespace

Members

API Navigation