MapperInterface.php

Same filename in other branches
  1. 9 core/lib/Drupal/Component/Plugin/Mapper/MapperInterface.php
  2. 8.9.x core/lib/Drupal/Component/Plugin/Mapper/MapperInterface.php
  3. 11.x core/lib/Drupal/Component/Plugin/Mapper/MapperInterface.php

Namespace

Drupal\Component\Plugin\Mapper

File

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

View source
<?php

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 or creates a plugin instance that satisfies the given options.
     *
     * @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 depend on the plugin type. If no instance can be retrieved, FALSE
     *   will be returned.
     */
    public function getInstance(array $options);

}

Interfaces

Title Deprecated Summary
MapperInterface Plugin mapper interface.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.