interface DataFilterManagerInterface in Typed Data API enhancements 8

Interface for the data filter manager.

Hierarchy

• interface \Drupal\Component\Plugin\Discovery\DiscoveryInterface; interface \Drupal\Component\Plugin\Factory\FactoryInterface; interface \Drupal\Component\Plugin\Mapper\MapperInterface
  • interface \Drupal\Component\Plugin\PluginManagerInterface
    • interface \Drupal\typed_data\DataFilterManagerInterface

File

src/DataFilterManagerInterface.php, line 10

Namespace

Drupal\typed_data

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 = []);

}

Members

Name	Modifiers	Type	Description	Overrides
DataFilterManagerInterface::createInstance	public	function	Creates a pre-configured instance of a filter plugin. Overrides FactoryInterface::createInstance
DiscoveryInterface::getDefinition	public	function	Gets a specific plugin definition.	4
DiscoveryInterface::getDefinitions	public	function	Gets the definition of all plugins for this type.	3
DiscoveryInterface::hasDefinition	public	function	Indicates if a specific plugin definition exists.	2
MapperInterface::getInstance	public	function	Gets a preconfigured instance of a plugin.	4