1. interface
  2. Drupal
  3. \
  4. Component
  5. \
  6. Plugin
  7. \
  8. CategorizingPluginManagerInterface

CategorizingPluginManagerInterface

interface CategorizingPluginManagerInterface implements PluginManagerInterface (View source)

Defines an interface for plugin managers that categorize plugin definitions.

Methods

mixed
getDefinition(string $plugin_id, bool $exception_on_invalid = TRUE)

Gets a specific plugin definition.

from  DiscoveryInterface
array
getDefinitions()

Gets the definition of all plugins for this type.

from  DiscoveryInterface
bool
hasDefinition(string $plugin_id)

Indicates if a specific plugin definition exists.

from  DiscoveryInterface
object
createInstance(string $plugin_id, array $configuration = [])

Creates a pre-configured instance of a plugin.

from  FactoryInterface
object|false
getInstance(array $options)

Gets a preconfigured instance of a plugin.

from  MapperInterface
string[]
getCategories()

Gets the names of all categories.

array[]
getSortedDefinitions(array $definitions = NULL)

Gets sorted plugin definitions.

array[]
getGroupedDefinitions(array $definitions = NULL)

Gets sorted plugin definitions grouped by category.

Details

in DiscoveryInterface at line 28
mixed getDefinition(string $plugin_id, bool $exception_on_invalid = TRUE)

Gets a specific plugin definition.

Parameters

string $plugin_id

A plugin id.
bool $exception_on_invalid

(optional) If TRUE, an invalid plugin ID will throw an exception.

Return Value

mixed

A plugin definition, or NULL if the plugin ID is invalid and $exception_on_invalid is FALSE.

Exceptions

PluginNotFoundException

in DiscoveryInterface at line 39
array getDefinitions()

Gets the definition of all plugins for this type.

Return Value

array

An array of plugin definitions (empty array if no definitions were found). Keys are plugin IDs.

See also

FilteredPluginManagerInterface::getFilteredDefinitions

in DiscoveryInterface at line 50
bool hasDefinition(string $plugin_id)

Indicates if a specific plugin definition exists.

Parameters

string $plugin_id

A plugin ID.

Return Value

bool

TRUE if the definition exists, FALSE otherwise.

in FactoryInterface at line 24
object createInstance(string $plugin_id, array $configuration = [])

Creates a pre-configured instance of a plugin.

Parameters

string $plugin_id

The ID of the plugin being instantiated.
array $configuration

An array of configuration relevant to the plugin instance.

Return Value

object

A fully configured plugin instance.

Exceptions

PluginException

in MapperInterface at line 28
object|false getInstance(array $options)

Gets a preconfigured instance of a plugin.

Parameters

array $options

An array of options that can be used to determine a suitable plugin to instantiate and how to configure it.

Return Value

object|false

A fully configured plugin instance. The interface of the plugin instance will depend on the plugin type. If no instance can be retrieved, FALSE will be returned.

at line 16
string[] getCategories()

Gets the names of all categories.

Return Value

string[]

An array of translated categories, sorted alphabetically.

at line 28
array[] getSortedDefinitions(array $definitions = NULL)

Gets sorted plugin definitions.

Parameters

array $definitions

(optional) The plugin definitions to sort. If omitted, all plugin definitions are used.

Return Value

array[]

An array of plugin definitions, sorted by category and label.

at line 44
array[] getGroupedDefinitions(array $definitions = NULL)

Gets sorted plugin definitions grouped by category.

In addition to grouping, both categories and its entries are sorted, whereas plugin definitions are sorted by label.

Parameters

array $definitions

(optional) The plugin definitions to group. If omitted, all plugin definitions are used.

Return Value

array[]

Keys are category names, and values are arrays of which the keys are plugin IDs and the values are plugin definitions.