MapperInterface.php in Plug 7

Contains \Drupal\Component\Plugin\Mapper\MapperInterface.

Namespace

Drupal\Component\Plugin\Mapper

File

lib/Drupal/Component/Plugin/Mapper/MapperInterface.php

<?php

/**
 * @file
 * Contains \Drupal\Component\Plugin\Mapper\MapperInterface.
 */
namespace Drupal\Component\Plugin\Mapper;


/**
 * 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.
 */
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);

}

Interfaces

Name	Description
MapperInterface	Plugin mapper interface.