1. interface
  2. Drupal
  3. \
  4. Component
  5. \
  6. Plugin
  7. \
  8. Mapper
  9. \
  10. MapperInterface

MapperInterface

interface MapperInterface (View source)

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.

Methods

object|false
getInstance(array $options)

Gets a preconfigured instance of a plugin.

Details

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.