1. class
  2. Drupal
  3. \
  4. Component
  5. \
  6. Plugin
  7. \
  8. Factory
  9. \
  10. DefaultFactory

DefaultFactory

class DefaultFactory implements FactoryInterface (View source)

Default plugin factory.

Instantiates plugin instances by passing the full configuration array as a single constructor argument. Plugin types wanting to support plugin classes with more flexible constructor signatures can do so by using an alternate factory such as Drupal\Component\Plugin\Factory\ReflectionFactory.

Properties

protected DiscoveryInterface $discovery

The object that retrieves the definitions of the plugins that this factory instantiates.
protected string|null $interface

Defines an interface each plugin should implement.

Methods

__construct(DiscoveryInterface $discovery, string|null $plugin_interface = NULL)

Constructs a Drupal\Component\Plugin\Factory\DefaultFactory object.

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

Creates a pre-configured instance of a plugin.

static string
getPluginClass(string $plugin_id, PluginDefinitionInterface|array $plugin_definition = NULL, string $required_interface = NULL)

Finds the class relevant for a given plugin.

Details

at line 44
__construct(DiscoveryInterface $discovery, string|null $plugin_interface = NULL)

Constructs a Drupal\Component\Plugin\Factory\DefaultFactory object.

Parameters

DiscoveryInterface $discovery

The plugin discovery.
string|null $plugin_interface

(optional) The interface each plugin should implement.

at line 52
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

at line 75
static string getPluginClass(string $plugin_id, PluginDefinitionInterface|array $plugin_definition = NULL, string $required_interface = NULL)

Finds the class relevant for a given plugin.

Parameters

string $plugin_id

The id of a plugin.
PluginDefinitionInterface|array $plugin_definition

The plugin definition associated with the plugin ID.
string $required_interface

(optional) The required plugin interface.

Return Value

string

The appropriate class name.

Exceptions

PluginException