class FormatTextFilter in Typed Data API enhancements 8

A data filter which marks string data as sanitized.

Plugin annotation

@DataFilter(
  id = "format_text",
  label = @Translation("The format_text filter passes the text through the given filter."),
)

Hierarchy

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

File

src/Plugin/TypedDataFilter/FormatTextFilter.php, line 19

Namespace

Drupal\typed_data\Plugin\TypedDataFilter

class FormatTextFilter extends DataFilterBase {

  /**
   * {@inheritdoc}
   */
  public function canFilter(DataDefinitionInterface $definition) {
    return is_subclass_of($definition
      ->getClass(), StringInterface::class);
  }

  /**
   * {@inheritdoc}
   */
  public function filtersTo(DataDefinitionInterface $definition, array $arguments) {
    return DataDefinition::create('string');
  }

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

  /**
   * {@inheritdoc}
   */
  public function validateArguments(DataDefinitionInterface $definition, array $arguments) {
    $errors = parent::validateArguments($definition, $arguments);
    if (isset($arguments[0])) {

      // Ensure the provided value is given for this data.
      $violations = $this
        ->getTypedDataManager()
        ->create($definition, $arguments[0])
        ->validate();
      foreach ($violations as $violation) {
        $errors[] = $violation
          ->getMessage();
      }
    }
    return $errors;
  }

  /**
   * {@inheritdoc}
   */
  public function filter(DataDefinitionInterface $definition, $value, array $arguments, BubbleableMetadata $bubbleable_metadata = NULL) {
    return check_markup($value, $arguments[0]);
  }

}

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::suggestArgument	public	function	Suggests some possible argument values based on user input. Overrides DataFilterInterface::suggestArgument
DataFilterBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	1
FormatTextFilter::canFilter	public	function	Determines whether data based upon the given definition can be filtered. Overrides DataFilterInterface::canFilter
FormatTextFilter::filter	public	function	Filters the given data value. Overrides DataFilterInterface::filter
FormatTextFilter::filtersTo	public	function	Describes the data after applying the filter. Overrides DataFilterInterface::filtersTo
FormatTextFilter::getNumberOfRequiredArguments	public	function	Gets the number of required arguments. Overrides DataFilterBase::getNumberOfRequiredArguments
FormatTextFilter::validateArguments	public	function	Validates the inputted arguments. Overrides DataFilterBase::validateArguments
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