class BlockManager
Same name in other branches
- 9 core/lib/Drupal/Core/Block/BlockManager.php \Drupal\Core\Block\BlockManager
- 8.9.x core/lib/Drupal/Core/Block/BlockManager.php \Drupal\Core\Block\BlockManager
- 11.x core/lib/Drupal/Core/Block/BlockManager.php \Drupal\Core\Block\BlockManager
Manages discovery and instantiation of block plugins.
@todo Add documentation to this class.
Hierarchy
- class \Drupal\Component\Plugin\PluginManagerBase implements \Drupal\Component\Plugin\PluginManagerInterface uses \Drupal\Component\Plugin\Discovery\DiscoveryTrait
- class \Drupal\Core\Plugin\DefaultPluginManager extends \Drupal\Component\Plugin\PluginManagerBase implements \Drupal\Component\Plugin\PluginManagerInterface, \Drupal\Component\Plugin\Discovery\CachedDiscoveryInterface, \Drupal\Core\Cache\CacheableDependencyInterface uses \Drupal\Component\Plugin\Discovery\DiscoveryCachedTrait, \Drupal\Core\Cache\UseCacheBackendTrait
- class \Drupal\Core\Block\BlockManager extends \Drupal\Core\Plugin\DefaultPluginManager implements \Drupal\Core\Block\BlockManagerInterface, \Drupal\Component\Plugin\FallbackPluginManagerInterface uses \Drupal\Core\Plugin\CategorizingPluginManagerTrait, \Drupal\Core\Plugin\FilteredPluginManagerTrait
- class \Drupal\Core\Plugin\DefaultPluginManager extends \Drupal\Component\Plugin\PluginManagerBase implements \Drupal\Component\Plugin\PluginManagerInterface, \Drupal\Component\Plugin\Discovery\CachedDiscoveryInterface, \Drupal\Core\Cache\CacheableDependencyInterface uses \Drupal\Component\Plugin\Discovery\DiscoveryCachedTrait, \Drupal\Core\Cache\UseCacheBackendTrait
Expanded class hierarchy of BlockManager
See also
\Drupal\Core\Block\BlockPluginInterface
1 file declares its use of BlockManager
- BlockManagerTest.php in core/
tests/ Drupal/ Tests/ Core/ Block/ BlockManagerTest.php
1 string reference to 'BlockManager'
- core.services.yml in core/
core.services.yml - core/core.services.yml
1 service uses BlockManager
File
-
core/
lib/ Drupal/ Core/ Block/ BlockManager.php, line 21
Namespace
Drupal\Core\BlockView source
class BlockManager extends DefaultPluginManager implements BlockManagerInterface, FallbackPluginManagerInterface {
use CategorizingPluginManagerTrait {
getSortedDefinitions as traitGetSortedDefinitions;
}
use FilteredPluginManagerTrait;
/**
* The logger.
*
* @var \Psr\Log\LoggerInterface
*/
protected $logger;
/**
* Constructs a new \Drupal\Core\Block\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.
* @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
* Cache backend instance to use.
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler to invoke the alter hook with.
* @param \Psr\Log\LoggerInterface $logger
* The logger.
*/
public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, LoggerInterface $logger) {
parent::__construct('Plugin/Block', $namespaces, $module_handler, 'Drupal\\Core\\Block\\BlockPluginInterface', Block::class, 'Drupal\\Core\\Block\\Annotation\\Block');
$this->alterInfo($this->getType());
$this->setCacheBackend($cache_backend, 'block_plugins');
$this->logger = $logger;
}
/**
* {@inheritdoc}
*/
protected function getType() {
return 'block';
}
/**
* {@inheritdoc}
*/
public function processDefinition(&$definition, $plugin_id) {
parent::processDefinition($definition, $plugin_id);
$this->processDefinitionCategory($definition);
}
/**
* {@inheritdoc}
*/
public function getSortedDefinitions(?array $definitions = NULL) {
// Sort the plugins first by category, then by admin label.
$definitions = $this->traitGetSortedDefinitions($definitions, 'admin_label');
// Do not display the 'broken' plugin in the UI.
unset($definitions['broken']);
return $definitions;
}
/**
* {@inheritdoc}
*/
public function getFallbackPluginId($plugin_id, array $configuration = []) {
return 'broken';
}
/**
* {@inheritdoc}
*/
protected function handlePluginNotFound($plugin_id, array $configuration) {
$this->logger
->warning('The "%plugin_id" was not found', [
'%plugin_id' => $plugin_id,
]);
return parent::handlePluginNotFound($plugin_id, $configuration);
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Member alias | Overriden Title | Overrides |
---|---|---|---|---|---|---|---|
BlockManager::$logger | protected | property | The logger. | ||||
BlockManager::getFallbackPluginId | public | function | Gets a fallback id for a missing plugin. | Overrides PluginManagerBase::getFallbackPluginId | |||
BlockManager::getSortedDefinitions | public | function | |||||
BlockManager::getType | protected | function | A string identifying the plugin type. | Overrides FilteredPluginManagerTrait::getType | |||
BlockManager::handlePluginNotFound | protected | function | Allows plugin managers to specify custom behavior if a plugin is not found. | Overrides PluginManagerBase::handlePluginNotFound | |||
BlockManager::processDefinition | public | function | Performs extra processing on plugin definitions. | Overrides DefaultPluginManager::processDefinition | |||
BlockManager::__construct | public | function | Constructs a new \Drupal\Core\Block\BlockManager object. | Overrides DefaultPluginManager::__construct | |||
CategorizingPluginManagerTrait::getCategories | public | function | |||||
CategorizingPluginManagerTrait::getGroupedDefinitions | public | function | |||||
CategorizingPluginManagerTrait::getModuleExtensionList | protected | function | Returns the module extension list used. | ||||
CategorizingPluginManagerTrait::getModuleHandler | Deprecated | public | function | Returns the module handler used. | |||
CategorizingPluginManagerTrait::getProviderName | protected | function | Gets the name of a provider. | ||||
CategorizingPluginManagerTrait::getSortedDefinitions | public | function | Aliased as: traitGetSortedDefinitions | ||||
CategorizingPluginManagerTrait::processDefinitionCategory | protected | function | Processes a plugin definition to ensure there is a category. | ||||
ContextAwarePluginManagerTrait::contextHandler | protected | function | Wraps the context handler. | 1 | |||
ContextAwarePluginManagerTrait::getDefinitions | abstract public | function | See \Drupal\Component\Plugin\Discovery\DiscoveryInterface::getDefinitions(). | 1 | |||
ContextAwarePluginManagerTrait::getDefinitionsForContexts | public | function | See \Drupal\Core\Plugin\Context\ContextAwarePluginManagerInterface::getDefinitionsForContexts(). | ||||
DefaultPluginManager::$additionalAnnotationNamespaces | protected | property | Additional annotation namespaces. | ||||
DefaultPluginManager::$alterHook | protected | property | Name of the alter hook if one should be invoked. | ||||
DefaultPluginManager::$cacheKey | protected | property | The cache key. | ||||
DefaultPluginManager::$cacheTags | protected | property | An array of cache tags to use for the cached definitions. | ||||
DefaultPluginManager::$defaults | protected | property | A set of defaults to be referenced by $this->processDefinition(). | 12 | |||
DefaultPluginManager::$moduleExtensionList | protected | property | The module extension list. | ||||
DefaultPluginManager::$moduleHandler | protected | property | The module handler to invoke the alter hook. | 1 | |||
DefaultPluginManager::$namespaces | protected | property | An object of root paths that are traversable. | ||||
DefaultPluginManager::$pluginDefinitionAnnotationName | protected | property | The name of the annotation that contains the plugin definition. | ||||
DefaultPluginManager::$pluginDefinitionAttributeName | protected | property | The name of the attribute that contains the plugin definition. | ||||
DefaultPluginManager::$pluginInterface | protected | property | The interface each plugin should implement. | 1 | |||
DefaultPluginManager::$subdir | protected | property | The subdirectory within a namespace to look for plugins. | ||||
DefaultPluginManager::alterDefinitions | protected | function | Invokes the hook to alter the definitions if the alter hook is set. | 5 | |||
DefaultPluginManager::alterInfo | protected | function | Sets the alter hook name. | ||||
DefaultPluginManager::clearCachedDefinitions | public | function | Clears static and persistent plugin definition caches. | Overrides CachedDiscoveryInterface::clearCachedDefinitions | 11 | ||
DefaultPluginManager::extractProviderFromDefinition | protected | function | Extracts the provider from a plugin definition. | ||||
DefaultPluginManager::findDefinitions | protected | function | Finds plugin definitions. | 7 | |||
DefaultPluginManager::getCacheContexts | public | function | The cache contexts associated with this object. | Overrides CacheableDependencyInterface::getCacheContexts | |||
DefaultPluginManager::getCachedDefinitions | protected | function | Returns the cached plugin definitions of the decorated discovery class. | ||||
DefaultPluginManager::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | Overrides CacheableDependencyInterface::getCacheMaxAge | |||
DefaultPluginManager::getCacheTags | public | function | The cache tags associated with this object. | Overrides CacheableDependencyInterface::getCacheTags | |||
DefaultPluginManager::getDiscovery | protected | function | Gets the plugin discovery. | Overrides PluginManagerBase::getDiscovery | 16 | ||
DefaultPluginManager::getFactory | protected | function | Gets the plugin factory. | Overrides PluginManagerBase::getFactory | |||
DefaultPluginManager::providerExists | protected | function | Determines if the provider of a definition exists. | 5 | |||
DefaultPluginManager::setCacheBackend | public | function | Initialize the cache backend. | ||||
DefaultPluginManager::setCachedDefinitions | protected | function | Sets a cache of plugin definitions for the decorated discovery class. | ||||
DefaultPluginManager::useCaches | public | function | Disable the use of caches. | Overrides CachedDiscoveryInterface::useCaches | 1 | ||
DiscoveryCachedTrait::$definitions | protected | property | Cached definitions array. | 1 | |||
DiscoveryCachedTrait::getDefinition | public | function | Overrides DiscoveryTrait::getDefinition | 3 | |||
DiscoveryTrait::doGetDefinition | protected | function | Gets a specific plugin definition. | ||||
DiscoveryTrait::hasDefinition | public | function | |||||
FilteredPluginManagerTrait::getFilteredDefinitions | public | function | Implements \Drupal\Core\Plugin\FilteredPluginManagerInterface::getFilteredDefinitions(). | ||||
FilteredPluginManagerTrait::moduleHandler | protected | function | Wraps the module handler. | 1 | |||
FilteredPluginManagerTrait::themeManager | protected | function | Wraps the theme manager. | 1 | |||
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::createInstance | public | function | 15 | ||||
PluginManagerBase::getInstance | public | function | 6 | ||||
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |||
StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | ||||
StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | ||||
StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | ||||
StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | |||
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | ||||
UseCacheBackendTrait::$cacheBackend | protected | property | Cache backend instance. | ||||
UseCacheBackendTrait::$useCaches | protected | property | Flag whether caches should be used or skipped. | ||||
UseCacheBackendTrait::cacheGet | protected | function | Fetches from the cache backend, respecting the use caches flag. | ||||
UseCacheBackendTrait::cacheSet | protected | function | Stores data in the persistent cache, respecting the use caches flag. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.