class BlockManager in Multiversion 8

Same name and namespace in other branches

8.2 src/Block/BlockManager.php \Drupal\multiversion\Block\BlockManager

Adds the workspace ID to the cache key.

Hierarchy

class \Drupal\Component\Plugin\PluginManagerBase implements PluginManagerInterface uses DiscoveryTrait
- class \Drupal\Core\Plugin\DefaultPluginManager implements CachedDiscoveryInterface, PluginManagerInterface, CacheableDependencyInterface uses DiscoveryCachedTrait, UseCacheBackendTrait
  - class \Drupal\Core\Block\BlockManager implements FallbackPluginManagerInterface, BlockManagerInterface uses CategorizingPluginManagerTrait, FilteredPluginManagerTrait
    class \Drupal\multiversion\Block\BlockManager

Expanded class hierarchy of BlockManager

File

src/Block/BlockManager.php, line 17

Namespace

Drupal\multiversion\Block

View source

class BlockManager extends CoreBlockManager {

  /**
   * The database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $database;

  /**
   * The workspace manager service.
   *
   * @var \Drupal\multiversion\Workspace\WorkspaceManagerInterface
   */
  protected $workspaceManager;

  /**
   * The string to prefix the workspace ID for the cache key.
   * @var string
   */
  protected $workspaceCacheKeyPrefix = 'block_plugins:workspace';

  /**
   * Constructs a new \Drupal\multiversion\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
   * @param \Drupal\Core\Database\Connection $database
   *   The database connection.
   * @param \Drupal\multiversion\Workspace\WorkspaceManagerInterface $workspace_manager
   *   The workspace manager service.
   */
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, LoggerInterface $logger, Connection $database, WorkspaceManagerInterface $workspace_manager) {
    parent::__construct($namespaces, $cache_backend, $module_handler, $logger);

    // @todo Remove this when Multiversion requires Drupal 8.6 or newer.
    if (floatval(\Drupal::VERSION) < 8.6) {
      parent::__construct($namespaces, $cache_backend, $module_handler);
    }
    else {
      parent::__construct($namespaces, $cache_backend, $module_handler, $logger);
    }
    $this->database = $database;
    $this->workspaceManager = $workspace_manager;
  }

  /**
   * {@inheritdoc}
   */
  protected function setCachedDefinitions($definitions) {
    $this->cacheKey = $this->workspaceCacheKeyPrefix . $this->workspaceManager
      ->getActiveWorkspaceId();
    parent::setCachedDefinitions($definitions);
  }

  /**
   * {@inheritdoc}
   */
  public function clearCachedDefinitions() {
    $active_workspace_id = $this->workspaceManager
      ->getActiveWorkspaceId();
    if (isset($active_workspace)) {
      $this->cacheKey = $this->workspaceCacheKeyPrefix . $active_workspace_id;
    }
    parent::clearCachedDefinitions();
  }

  /**
   * {@inheritdoc}
   */
  protected function getCachedDefinitions() {
    $this->cacheKey = $this->workspaceCacheKeyPrefix . $this->workspaceManager
      ->getActiveWorkspaceId();
    parent::getCachedDefinitions();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BlockManager::$database	protected	property	The database connection.
BlockManager::$logger	protected	property	The logger.
BlockManager::$workspaceCacheKeyPrefix	protected	property	The string to prefix the workspace ID for the cache key.
BlockManager::$workspaceManager	protected	property	The workspace manager service.
BlockManager::clearCachedDefinitions	public	function	Clears static and persistent plugin definition caches. Overrides DefaultPluginManager::clearCachedDefinitions
BlockManager::getCachedDefinitions	protected	function	Returns the cached plugin definitions of the decorated discovery class. Overrides DefaultPluginManager::getCachedDefinitions
BlockManager::getFallbackPluginId	public	function	Gets a fallback id for a missing plugin. Overrides FallbackPluginManagerInterface::getFallbackPluginId
BlockManager::getSortedDefinitions	public	function	Gets sorted plugin definitions. Overrides CategorizingPluginManagerInterface::getSortedDefinitions
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::setCachedDefinitions	protected	function	Sets a cache of plugin definitions for the decorated discovery class. Overrides DefaultPluginManager::setCachedDefinitions
BlockManager::__construct	public	function	Constructs a new \Drupal\multiversion\Block\BlockManager object. Overrides BlockManager::__construct
CategorizingPluginManagerTrait::getCategories	public	function
CategorizingPluginManagerTrait::getGroupedDefinitions	public	function
CategorizingPluginManagerTrait::getModuleHandler	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 namespaces the annotation discovery mechanism should scan for annotation definitions.
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() if additional processing of plugins is necessary or helpful for development purposes.	9
DefaultPluginManager::$moduleHandler	protected	property	The module handler to invoke the alter hook.	1
DefaultPluginManager::$namespaces	protected	property	An object that implements \Traversable which contains the root paths keyed by the corresponding namespace to look for plugin implementations.
DefaultPluginManager::$pluginDefinitionAnnotationName	protected	property	The name of the annotation 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, or FALSE if the plugins are in the top level of the namespace.
DefaultPluginManager::alterDefinitions	protected	function	Invokes the hook to alter the definitions if the alter hook is set.	1
DefaultPluginManager::alterInfo	protected	function	Sets the alter hook name.
DefaultPluginManager::extractProviderFromDefinition	protected	function	Extracts the provider from a plugin definition.
DefaultPluginManager::findDefinitions	protected	function	Finds plugin definitions.	7
DefaultPluginManager::fixContextAwareDefinitions	private	function	Fix the definitions of context-aware plugins.
DefaultPluginManager::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
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	12
DefaultPluginManager::getFactory	protected	function	Gets the plugin factory. Overrides PluginManagerBase::getFactory
DefaultPluginManager::providerExists	protected	function	Determines if the provider of a definition exists.	3
DefaultPluginManager::setCacheBackend	public	function	Initialize the cache backend.
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	Creates a pre-configured instance of a plugin. Overrides FactoryInterface::createInstance	12
PluginManagerBase::getInstance	public	function	Gets a preconfigured instance of a plugin. Overrides MapperInterface::getInstance	7
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.	1
UseCacheBackendTrait::cacheSet	protected	function	Stores data in the persistent cache, respecting the use caches flag.

You are here

class BlockManager in Multiversion 8

Hierarchy

See also

File

Namespace

Members

API Navigation