You are here

interface FactoryInterface in Plug 7

Factory interface implemented by all plugin factories.

Hierarchy

Expanded class hierarchy of FactoryInterface

All classes that implement FactoryInterface

1 file declares its use of FactoryInterface
PluginManagerInterface.php in lib/Drupal/Component/Plugin/PluginManagerInterface.php
Contains \Drupal\Component\Plugin\PluginManagerInterface.

File

lib/Drupal/Component/Plugin/Factory/FactoryInterface.php, line 12
Contains \Drupal\Component\Plugin\Factory\FactoryInterface.

Namespace

Drupal\Component\Plugin\Factory
View source
interface FactoryInterface {

  /**
   * Creates a pre-configured instance of a plugin.
   *
   * @param string $plugin_id
   *   The ID of the plugin being instantiated.
   * @param array $configuration
   *   An array of configuration relevant to the plugin instance.
   *
   * @return object
   *   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 = array());

}

Members

Namesort descending Modifiers Type Description Overrides
FactoryInterface::createInstance public function Creates a pre-configured instance of a plugin. 2