Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Core\Block;
Chris@0: 
Chris@0: use Drupal\Component\Plugin\FallbackPluginManagerInterface;
Chris@0: use Drupal\Core\Cache\CacheBackendInterface;
Chris@0: use Drupal\Core\Extension\ModuleHandlerInterface;
Chris@0: use Drupal\Core\Plugin\CategorizingPluginManagerTrait;
Chris@0: use Drupal\Core\Plugin\Context\ContextAwarePluginManagerTrait;
Chris@0: use Drupal\Core\Plugin\DefaultPluginManager;
Chris@0: 
Chris@0: /**
Chris@0:  * Manages discovery and instantiation of block plugins.
Chris@0:  *
Chris@0:  * @todo Add documentation to this class.
Chris@0:  *
Chris@0:  * @see \Drupal\Core\Block\BlockPluginInterface
Chris@0:  */
Chris@0: class BlockManager extends DefaultPluginManager implements BlockManagerInterface, FallbackPluginManagerInterface {
Chris@0: 
Chris@0:   use CategorizingPluginManagerTrait {
Chris@0:     getSortedDefinitions as traitGetSortedDefinitions;
Chris@0:   }
Chris@0:   use ContextAwarePluginManagerTrait;
Chris@0: 
Chris@0:   /**
Chris@0:    * Constructs a new \Drupal\Core\Block\BlockManager object.
Chris@0:    *
Chris@0:    * @param \Traversable $namespaces
Chris@0:    *   An object that implements \Traversable which contains the root paths
Chris@0:    *   keyed by the corresponding namespace to look for plugin implementations.
Chris@0:    * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
Chris@0:    *   Cache backend instance to use.
Chris@0:    * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
Chris@0:    *   The module handler to invoke the alter hook with.
Chris@0:    */
Chris@0:   public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
Chris@0:     parent::__construct('Plugin/Block', $namespaces, $module_handler, 'Drupal\Core\Block\BlockPluginInterface', 'Drupal\Core\Block\Annotation\Block');
Chris@0: 
Chris@0:     $this->alterInfo('block');
Chris@0:     $this->setCacheBackend($cache_backend, 'block_plugins');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function processDefinition(&$definition, $plugin_id) {
Chris@0:     parent::processDefinition($definition, $plugin_id);
Chris@0:     $this->processDefinitionCategory($definition);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getSortedDefinitions(array $definitions = NULL) {
Chris@0:     // Sort the plugins first by category, then by admin label.
Chris@0:     $definitions = $this->traitGetSortedDefinitions($definitions, 'admin_label');
Chris@0:     // Do not display the 'broken' plugin in the UI.
Chris@0:     unset($definitions['broken']);
Chris@0:     return $definitions;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getFallbackPluginId($plugin_id, array $configuration = []) {
Chris@0:     return 'broken';
Chris@0:   }
Chris@0: 
Chris@0: }