class ImageToolkitOperationManager
Same name and namespace in other branches
- 11.x core/lib/Drupal/Core/ImageToolkit/ImageToolkitOperationManager.php \Drupal\Core\ImageToolkit\ImageToolkitOperationManager
- 10 core/lib/Drupal/Core/ImageToolkit/ImageToolkitOperationManager.php \Drupal\Core\ImageToolkit\ImageToolkitOperationManager
- 9 core/lib/Drupal/Core/ImageToolkit/ImageToolkitOperationManager.php \Drupal\Core\ImageToolkit\ImageToolkitOperationManager
- 8.9.x core/lib/Drupal/Core/ImageToolkit/ImageToolkitOperationManager.php \Drupal\Core\ImageToolkit\ImageToolkitOperationManager
Manages toolkit operation plugins.
Hierarchy
- class \Drupal\Component\Plugin\PluginManagerBase implements \Drupal\Component\Plugin\PluginManagerInterface uses \Drupal\Component\Plugin\Discovery\DiscoveryTrait
- class \Drupal\Core\Plugin\DefaultPluginManager implements \Drupal\Component\Plugin\PluginManagerInterface, \Drupal\Component\Plugin\Discovery\CachedDiscoveryInterface, \Drupal\Core\Cache\CacheableDependencyInterface uses \Drupal\Component\Plugin\Discovery\DiscoveryCachedTrait, \Drupal\Core\Cache\UseCacheBackendTrait extends \Drupal\Component\Plugin\PluginManagerBase
- class \Drupal\Core\ImageToolkit\ImageToolkitOperationManager implements \Drupal\Core\ImageToolkit\ImageToolkitOperationManagerInterface extends \Drupal\Core\Plugin\DefaultPluginManager
- class \Drupal\Core\Plugin\DefaultPluginManager implements \Drupal\Component\Plugin\PluginManagerInterface, \Drupal\Component\Plugin\Discovery\CachedDiscoveryInterface, \Drupal\Core\Cache\CacheableDependencyInterface uses \Drupal\Component\Plugin\Discovery\DiscoveryCachedTrait, \Drupal\Core\Cache\UseCacheBackendTrait extends \Drupal\Component\Plugin\PluginManagerBase
Expanded class hierarchy of ImageToolkitOperationManager
See also
\Drupal\Core\ImageToolkit\Annotation\ImageToolkitOperation
\Drupal\Core\ImageToolkit\ImageToolkitOperationBase
\Drupal\Core\ImageToolkit\ImageToolkitOperationInterface
1 string reference to 'ImageToolkitOperationManager'
- core.services.yml in core/
core.services.yml - core/core.services.yml
1 service uses ImageToolkitOperationManager
File
-
core/
lib/ Drupal/ Core/ ImageToolkit/ ImageToolkitOperationManager.php, line 22
Namespace
Drupal\Core\ImageToolkitView source
class ImageToolkitOperationManager extends DefaultPluginManager implements ImageToolkitOperationManagerInterface {
/**
* A logger instance.
*
* @var \Psr\Log\LoggerInterface
*
* @deprecated in drupal:11.4.0 and is removed from drupal:13.0.0. There is no replacement.
*
* @see https://www.drupal.org/node/3562304
*/
protected $logger;
/**
* The image toolkit manager.
*/
protected readonly ImageToolkitManager $toolkitManager;
/**
* Constructs the ImageToolkitOperationManager 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 \Drupal\Core\ImageToolkit\ImageToolkitManager|\Psr\Log\LoggerInterface $logger
* (deprecated) A logger instance.
* @param \Drupal\Core\ImageToolkit\ImageToolkitManager|null $toolkit_manager
* The image toolkit manager.
*/
public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, #[Autowire(service: ImageToolkitManager::class)] ImageToolkitManager|LoggerInterface $logger, ?ImageToolkitManager $toolkit_manager = NULL) {
parent::__construct('Plugin/ImageToolkit/Operation', $namespaces, $module_handler, ImageToolkitOperationInterface::class, ImageToolkitOperation::class, 'Drupal\\Core\\ImageToolkit\\Annotation\\ImageToolkitOperation');
$this->alterInfo('image_toolkit_operation');
$this->setCacheBackend($cache_backend, 'image_toolkit_operation_plugins');
if ($logger instanceof LoggerInterface) {
@trigger_error('The $logger argument of ' . __METHOD__ . ' is deprecated in drupal:11.4.0 and the argument is removed from drupal:13.0.0. See https://www.drupal.org/node/3562304', E_USER_DEPRECATED);
// @phpstan-ignore property.deprecated
$this->logger = $logger;
$this->toolkitManager = $toolkit_manager;
}
else {
// @phpstan-ignore property.deprecated
$this->logger = NULL;
$this->toolkitManager = $logger;
}
}
/**
* Returns the plugin ID for a given toolkit and operation.
*
* @param \Drupal\Core\ImageToolkit\ImageToolkitInterface $toolkit
* The toolkit instance.
* @param string $operation
* The operation (e.g. "crop").
*
* @return string
* The plugin ID.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
* When no plugin is available.
*/
protected function getToolkitOperationPluginId(ImageToolkitInterface $toolkit, $operation) {
$toolkit_id = $toolkit->getPluginId();
$definitions = $this->getDefinitions();
$definitions = array_filter($definitions, function ($definition) use ($toolkit_id, $operation) {
return $definition['toolkit'] == $toolkit_id && $definition['operation'] == $operation;
});
if (!$definitions) {
// If this image toolkit plugin is a derivative and returns no operation,
// try once again with its base plugin.
$base_toolkit_id = $toolkit->getBaseId();
if ($toolkit_id != $base_toolkit_id && !empty($base_toolkit_id)) {
$base_toolkit = $this->toolkitManager
->createInstance($base_toolkit_id);
return $this->getToolkitOperationPluginId($base_toolkit, $operation);
}
$message = new FormattableMarkup("No image operation plugin for '@toolkit' toolkit and '@operation' operation.", [
'@toolkit' => $toolkit_id,
'@operation' => $operation,
]);
throw new PluginNotFoundException($toolkit_id . '.' . $operation, $message);
}
else {
// Pickup the first plugin found.
// @todo In https://www.drupal.org/node/2110591 we'll return here the UI
// selected plugin or the first found if missed.
$definition = reset($definitions);
return $definition['id'];
}
}
/**
* {@inheritdoc}
*/
public function createInstance($plugin_id, array $configuration = [], ?ImageToolkitInterface $toolkit = NULL) {
$instance = parent::createInstance($plugin_id, $configuration);
$instance->setToolkit($toolkit);
return $instance;
}
/**
* {@inheritdoc}
*/
public function getToolkitOperation(ImageToolkitInterface $toolkit, $operation) {
$plugin_id = $this->getToolkitOperationPluginId($toolkit, $operation);
return $this->createInstance($plugin_id, [], $toolkit);
}
}
Members
| Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
|---|---|---|---|---|---|---|
| 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(). | 11 | ||
| 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. | 4 | ||
| DefaultPluginManager::alterInfo | protected | function | Sets the alter hook name. | |||
| DefaultPluginManager::clearCachedDefinitions | public | function | Clears static and persistent plugin definition caches. | Overrides CachedDiscoveryInterface::clearCachedDefinitions | 10 | |
| 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::getDefinitions | public | function | Gets the definition of all plugins for this type. | Overrides DiscoveryTrait::getDefinitions | 2 | |
| DefaultPluginManager::getDiscovery | protected | function | Gets the plugin discovery. | Overrides PluginManagerBase::getDiscovery | 16 | |
| DefaultPluginManager::getFactory | protected | function | Gets the plugin factory. | Overrides PluginManagerBase::getFactory | ||
| DefaultPluginManager::processDefinition | public | function | Performs extra processing on plugin definitions. | 16 | ||
| 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 | ||||
| ImageToolkitOperationManager::$logger | Deprecated | protected | property | A logger instance. | ||
| ImageToolkitOperationManager::$toolkitManager | protected | property | The image toolkit manager. | |||
| ImageToolkitOperationManager::createInstance | public | function | Creates a plugin instance based on the provided ID and configuration. | Overrides PluginManagerBase::createInstance | ||
| ImageToolkitOperationManager::getToolkitOperation | public | function | Returns a toolkit operation plugin instance. | Overrides ImageToolkitOperationManagerInterface::getToolkitOperation | ||
| ImageToolkitOperationManager::getToolkitOperationPluginId | protected | function | Returns the plugin ID for a given toolkit and operation. | |||
| ImageToolkitOperationManager::__construct | public | function | Constructs the ImageToolkitOperationManager object. | Overrides DefaultPluginManager::__construct | ||
| 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 preconfigured plugin instance for a particular runtime condition. | |||
| PluginManagerBase::getFallbackPluginId | protected | function | Gets a fallback id for a missing plugin. | 6 | ||
| PluginManagerBase::getInstance | public | function | Gets or creates a plugin instance that satisfies the given options. | Overrides MapperInterface::getInstance | 6 | |
| PluginManagerBase::handlePluginNotFound | protected | function | Allows plugin managers to specify custom behavior if a plugin is not found. | 1 | ||
| 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.