interface MapperInterface in Plug 7
Plugin mapper interface.
Plugin mappers are responsible for mapping a plugin request to its implementation. For example, it might map a cache bin to a memcache bin.
Mapper objects incorporate the best practices of retrieving configurations, type information, and factory instantiation.
Hierarchy
- interface \Drupal\Component\Plugin\Mapper\MapperInterface
Expanded class hierarchy of MapperInterface
All classes that implement MapperInterface
1 file declares its use of MapperInterface
- PluginManagerInterface.php in lib/
Drupal/ Component/ Plugin/ PluginManagerInterface.php - Contains \Drupal\Component\Plugin\PluginManagerInterface.
File
- lib/
Drupal/ Component/ Plugin/ Mapper/ MapperInterface.php, line 18 - Contains \Drupal\Component\Plugin\Mapper\MapperInterface.
Namespace
Drupal\Component\Plugin\MapperView source
interface MapperInterface {
/**
* Gets a preconfigured instance of a plugin.
*
* @param array $options
* An array of options that can be used to determine a suitable plugin to
* instantiate and how to configure it.
*
* @return object|false
* A fully configured plugin instance. The interface of the plugin instance
* will depends on the plugin type. If no instance can be retrieved, FALSE
* will be returned.
*/
public function getInstance(array $options);
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
MapperInterface:: |
public | function | Gets a preconfigured instance of a plugin. | 1 |