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.
Expanded class hierarchy of MapperInterface
All classes that implement MapperInterface
interface MapperInterface {
/**
* Returns 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
* A fully configured plugin instance. The interface of the plugin instance
* will depends on the plugin type.
*/
public function getInstance(array $options);
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
MapperInterface:: |
public | function | Returns a preconfigured instance of a plugin. | 1 |