You are here

DataFilterManagerInterface.php in Typed Data API enhancements 8

Namespace

Drupal\typed_data

File

src/DataFilterManagerInterface.php
View source
<?php

namespace Drupal\typed_data;

use Drupal\Component\Plugin\PluginManagerInterface;

/**
 * Interface for the data filter manager.
 */
interface DataFilterManagerInterface extends PluginManagerInterface {

  /**
   * Creates a pre-configured instance of a filter plugin.
   *
   * @param string $plugin_id
   *   The ID of the plugin being instantiated; i.e., the filter machine name.
   * @param array $configuration
   *   An array of configuration relevant to the plugin instance. As this plugin
   *   is not configurable, this is unused and should stay empty.
   *
   * @return \Drupal\typed_data\DataFilterInterface
   *   A fully configured plugin instance.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   *   If the instance cannot be created, such as if the ID is invalid.
   */
  public function createInstance($plugin_id, array $configuration = []);

}

Interfaces

Namesort descending Description
DataFilterManagerInterface Interface for the data filter manager.