class CategorizingPluginManager
Same name in other branches
- 9 core/tests/Drupal/Tests/Core/Plugin/CategorizingPluginManagerTraitTest.php \Drupal\Tests\Core\Plugin\CategorizingPluginManager
- 8.9.x core/tests/Drupal/Tests/Core/Plugin/CategorizingPluginManagerTraitTest.php \Drupal\Tests\Core\Plugin\CategorizingPluginManager
- 10 core/tests/Drupal/Tests/Core/Plugin/CategorizingPluginManagerTraitTest.php \Drupal\Tests\Core\Plugin\CategorizingPluginManager
Class that allows testing the trait.
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\Tests\Core\Plugin\CategorizingPluginManager extends \Drupal\Core\Plugin\DefaultPluginManager implements \Drupal\Component\Plugin\CategorizingPluginManagerInterface uses \Drupal\Core\Plugin\CategorizingPluginManagerTrait
- 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 CategorizingPluginManager
File
-
core/
tests/ Drupal/ Tests/ Core/ Plugin/ CategorizingPluginManagerTraitTest.php, line 115
Namespace
Drupal\Tests\Core\PluginView source
class CategorizingPluginManager extends DefaultPluginManager implements CategorizingPluginManagerInterface {
use CategorizingPluginManagerTrait;
/**
* Replace the constructor so we can instantiate a stub.
*
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler.
* @param \Drupal\Core\Extension\ModuleExtensionList $module_extension_list
* The module extension list.
*/
public function __construct(ModuleHandlerInterface $module_handler, ModuleExtensionList $module_extension_list) {
$this->moduleHandler = $module_handler;
$this->moduleExtensionList = $module_extension_list;
}
/**
* {@inheritdoc}
*
* Provides some test definitions to the trait.
*/
public function getDefinitions() {
return [
'cucumber' => [
'label' => 'cucumber',
'category' => 'vegetables',
],
'apple' => [
'label' => 'apple',
'category' => 'fruits',
],
'mango' => [
'label' => 'mango',
'category' => 'fruits',
],
];
}
/**
* {@inheritdoc}
*/
public function processDefinition(&$definition, $plugin_id) {
parent::processDefinition($definition, $plugin_id);
$this->processDefinitionCategory($definition);
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
CategorizingPluginManager::getDefinitions | public | function | Provides some test definitions to the trait. | Overrides DefaultPluginManager::getDefinitions | ||
CategorizingPluginManager::processDefinition | public | function | Performs extra processing on plugin definitions. | Overrides DefaultPluginManager::processDefinition | ||
CategorizingPluginManager::__construct | public | function | Replace the constructor so we can instantiate a stub. | 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 | ||||
CategorizingPluginManagerTrait::processDefinitionCategory | protected | function | Processes a plugin definition to ensure there is a category. | |||
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 | ||||
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::getFallbackPluginId | protected | function | Gets a fallback id for a missing plugin. | 6 | ||
PluginManagerBase::getInstance | public | function | 6 | |||
PluginManagerBase::handlePluginNotFound | protected | function | Allows plugin managers to specify custom behavior if a plugin is not found. | 1 | ||
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.