abstract class DataFilterBase in Typed Data API enhancements 8

Base class for data filters.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\typed_data\DataFilterBase implements DataFilterInterface uses StringTranslationTrait, TypedDataTrait

6 files declare their use of DataFilterBase

DefaultFilter.php in src/Plugin/TypedDataFilter/DefaultFilter.php

EntityUrlFilter.php in src/Plugin/TypedDataFilter/EntityUrlFilter.php

FormatDateFilter.php in src/Plugin/TypedDataFilter/FormatDateFilter.php

FormatTextFilter.php in src/Plugin/TypedDataFilter/FormatTextFilter.php

LowerFilter.php in src/Plugin/TypedDataFilter/LowerFilter.php

... See full list

File

src/DataFilterBase.php, line 13

Namespace

Drupal\typed_data

abstract class DataFilterBase extends PluginBase implements DataFilterInterface {
  use TypedDataTrait;
  use StringTranslationTrait;

  /**
   * The filter id.
   *
   * @var string
   */
  protected $filterId;

  /**
   * The plugin definition.
   *
   * @var array
   */
  protected $pluginDefinition;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->filterId = $plugin_id;
    $this->pluginDefinition = $plugin_definition;
  }

  /**
   * {@inheritdoc}
   */
  public function getNumberOfRequiredArguments() {
    return 0;
  }

  /**
   * {@inheritdoc}
   */
  public function allowsNullValues() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function suggestArgument(DataDefinitionInterface $definition, array $arguments, $input = '') {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function validateArguments(DataDefinitionInterface $definition, array $arguments) {
    $errors = [];
    if (count($arguments) < $this
      ->getNumberOfRequiredArguments()) {
      $errors[] = $this
        ->t('Missing arguments for filter %filter_id', [
        '%filter_id' => $this->filterId,
      ]);
    }
    return $errors;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DataFilterBase::$filterId	protected	property	The filter id.
DataFilterBase::$pluginDefinition	protected	property	The plugin definition. Overrides PluginBase::$pluginDefinition
DataFilterBase::allowsNullValues	public	function	Defines whether the filter is able to process NULL values. Overrides DataFilterInterface::allowsNullValues	1
DataFilterBase::getNumberOfRequiredArguments	public	function	Gets the number of required arguments. Overrides DataFilterInterface::getNumberOfRequiredArguments	2
DataFilterBase::suggestArgument	public	function	Suggests some possible argument values based on user input. Overrides DataFilterInterface::suggestArgument
DataFilterBase::validateArguments	public	function	Validates the inputted arguments. Overrides DataFilterInterface::validateArguments	3
DataFilterBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	1
DataFilterInterface::canFilter	public	function	Determines whether data based upon the given definition can be filtered.	6
DataFilterInterface::filter	public	function	Filters the given data value.	6
DataFilterInterface::filtersTo	public	function	Describes the data after applying the filter.	6
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	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.
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.
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2