class BlockManager

Manages discovery and instantiation of block plugins.

@todo Add documentation to this class.

Hierarchy

Expanded class hierarchy of BlockManager

See also

\Drupal\block\BlockPluginInterface

1 string reference to 'BlockManager'
block.services.yml in drupal/core/modules/block/block.services.yml
drupal/core/modules/block/block.services.yml
1 service uses BlockManager
plugin.manager.block in drupal/core/modules/block/block.services.yml
Drupal\block\Plugin\Type\BlockManager

File

drupal/core/modules/block/lib/Drupal/block/Plugin/Type/BlockManager.php, line 25

Namespace

Drupal\block\Plugin\Type
View source
class BlockManager extends PluginManagerBase {

  /**
   * Constructs a new \Drupal\block\Plugin\Type\BlockManager object.
   *
   * @param \Traversable $namespaces
   *   An object that implements \Traversable which contains the root paths
   *   keyed by the corresponding namespace to look for plugin implementations,
   */
  public function __construct(\Traversable $namespaces) {
    $this->discovery = new AnnotatedClassDiscovery('Block', $namespaces);
    $this->discovery = new DerivativeDiscoveryDecorator($this->discovery);
    $this->discovery = new AlterDecorator($this->discovery, 'block');
    $this->discovery = new CacheDecorator($this->discovery, 'block_plugins:' . language(Language::TYPE_INTERFACE)->langcode, 'block', CacheBackendInterface::CACHE_PERMANENT, array(
      'block',
    ));
    $this->factory = new DefaultFactory($this->discovery);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockManager::__construct public function Constructs a new \Drupal\block\Plugin\Type\BlockManager object.
PluginManagerBase::$defaults protected property A set of defaults to be referenced by $this->processDefinition() if additional processing of plugins is necessary or helpful for development purposes. 3
PluginManagerBase::$discovery protected property The object that discovers plugins managed by this manager.
PluginManagerBase::$factory protected property The object that instantiates plugins managed by this manager.
PluginManagerBase::$mapper protected property The object that returns the preconfigured plugin instance appropriate for a particular runtime condition.
PluginManagerBase::clearCachedDefinitions public function Clears static and persistent plugin definition caches. Overrides CachedDiscoveryInterface::clearCachedDefinitions
PluginManagerBase::createInstance public function Returns a preconfigured instance of a plugin. Overrides FactoryInterface::createInstance 6
PluginManagerBase::getDefinition public function Gets a specific plugin definition. Overrides DiscoveryInterface::getDefinition
PluginManagerBase::getDefinitions public function Gets the definition of all plugins for this type. Overrides DiscoveryInterface::getDefinitions
PluginManagerBase::getInstance public function Returns a preconfigured instance of a plugin. Overrides MapperInterface::getInstance 6
PluginManagerBase::processDefinition public function Performs extra processing on plugin definitions. 2