class ExcludeSpecifiedItemsProcessor in Facets 8

Provides a processor that excludes specified items.

Plugin annotation


@FacetsProcessor(
  id = "exclude_specified_items",
  label = @Translation("Exclude specified items"),
  description = @Translation("Exclude items depending on their raw or display value (such as node IDs or titles)."),
  stages = {
    "build" = 50
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\facets\Processor\ProcessorPluginBase implements ProcessorInterface uses DependencyTrait
    class \Drupal\facets\Plugin\facets\processor\ExcludeSpecifiedItemsProcessor implements BuildProcessorInterface

Expanded class hierarchy of ExcludeSpecifiedItemsProcessor

1 file declares its use of ExcludeSpecifiedItemsProcessor

ExcludeSpecifiedItemsProcessorTest.php in tests/src/Unit/Plugin/processor/ExcludeSpecifiedItemsProcessorTest.php

File

src/Plugin/facets/processor/ExcludeSpecifiedItemsProcessor.php, line 22

Namespace

Drupal\facets\Plugin\facets\processor

View source

class ExcludeSpecifiedItemsProcessor extends ProcessorPluginBase implements BuildProcessorInterface {

  /**
   * {@inheritdoc}
   */
  public function build(FacetInterface $facet, array $results) {
    $config = $this
      ->getConfiguration();

    /** @var \Drupal\facets\Result\ResultInterface $result */
    $exclude_item = $config['exclude'];
    foreach ($results as $id => $result) {
      $is_excluded = FALSE;
      if ($config['regex']) {
        $matcher = '/' . trim(str_replace('/', '\\/', $exclude_item)) . '/';
        if (preg_match($matcher, $result
          ->getRawValue()) || preg_match($matcher, $result
          ->getDisplayValue())) {
          $is_excluded = TRUE;
        }
      }
      else {
        $exclude_items = explode(',', $exclude_item);
        foreach ($exclude_items as $item) {
          $item = trim($item);
          if ($result
            ->getRawValue() == $item || $result
            ->getDisplayValue() == $item) {
            $is_excluded = TRUE;
          }
        }
      }

      // Invert the is_excluded result when the invert setting is active.
      if ($config['invert']) {
        $is_excluded = !$is_excluded;
      }

      // Filter by the excluded results.
      if ($is_excluded) {
        unset($results[$id]);
      }
    }
    return $results;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state, FacetInterface $facet) {
    $config = $this
      ->getConfiguration();
    $build['exclude'] = [
      '#title' => $this
        ->t('Exclude items'),
      '#type' => 'textarea',
      '#default_value' => $config['exclude'],
      '#description' => $this
        ->t("Comma separated list of titles or values that should be excluded, matching either an item's title or value."),
    ];
    $build['regex'] = [
      '#title' => $this
        ->t('Regular expressions used'),
      '#type' => 'checkbox',
      '#default_value' => $config['regex'],
      '#description' => $this
        ->t('Interpret each exclude list item as a regular expression pattern.<br /><small>(Slashes are escaped automatically, patterns using a comma can be wrapped in "double quotes", and if such a pattern uses double quotes itself, just make them double-double-quotes (""))</small>.'),
    ];
    $build['invert'] = array(
      '#title' => t('Invert - only list matched items'),
      '#type' => 'checkbox',
      '#default_value' => $config['invert'],
      '#description' => $this
        ->t('Instead of excluding items based on the pattern specified above, only matching items will be displayed.'),
    );
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'exclude' => '',
      'regex' => 0,
      'invert' => 0,
    ];
  }

}

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
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency.
ExcludeSpecifiedItemsProcessor::build	public	function	Runs before the renderable array is created. Overrides BuildProcessorInterface::build
ExcludeSpecifiedItemsProcessor::buildConfigurationForm	public	function	Adds a configuration form for this processor. Overrides ProcessorPluginBase::buildConfigurationForm
ExcludeSpecifiedItemsProcessor::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ProcessorPluginBase::defaultConfiguration
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::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
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::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
ProcessorInterface::STAGE_BUILD		constant	Processing stage: build.
ProcessorInterface::STAGE_POST_QUERY		constant	Processing stage: post_query.
ProcessorInterface::STAGE_PRE_QUERY		constant	Processing stage: pre_query.
ProcessorInterface::STAGE_SORT		constant	Processing stage: sort.
ProcessorPluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ProcessorPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ProcessorPluginBase::getDefaultWeight	public	function	Returns the default weight for a specific processing stage. Overrides ProcessorInterface::getDefaultWeight
ProcessorPluginBase::getDescription	public	function	Retrieves the processor description. Overrides ProcessorInterface::getDescription
ProcessorPluginBase::getQueryType	public	function	Picks the preferred query type for this widget. Overrides ProcessorInterface::getQueryType	4
ProcessorPluginBase::isHidden	public	function	Determines whether this processor should be hidden from the user. Overrides ProcessorInterface::isHidden
ProcessorPluginBase::isLocked	public	function	Determines whether this processor should always be enabled. Overrides ProcessorInterface::isLocked
ProcessorPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ProcessorPluginBase::submitConfigurationForm	public	function
ProcessorPluginBase::supportsFacet	public	function	Checks if the facet is supported by this widget. Overrides ProcessorInterface::supportsFacet	6
ProcessorPluginBase::supportsStage	public	function	Checks whether this processor implements a particular stage. Overrides ProcessorInterface::supportsStage
ProcessorPluginBase::validateConfigurationForm	public	function	Validates a configuration form for this processor. Overrides ProcessorInterface::validateConfigurationForm	2
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.

You are here

class ExcludeSpecifiedItemsProcessor in Facets 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation