Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. ImageToolkitManager.php

class ImageToolkitManager

Manages image toolkit plugins.

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\ImageToolkit\ImageToolkitManager extends \Drupal\Core\Plugin\DefaultPluginManager

Expanded class hierarchy of ImageToolkitManager

See also

\Drupal\Core\ImageToolkit\Annotation\ImageToolkit

\Drupal\Core\ImageToolkit\ImageToolkitInterface

\Drupal\Core\ImageToolkit\ImageToolkitBase

Plugin API

2 files declare their use of ImageToolkitManager
ImageFactory.php in core/lib/Drupal/Core/Image/ImageFactory.php
ImageToolkitForm.php in core/modules/system/src/Form/ImageToolkitForm.php

File

core/lib/Drupal/Core/ImageToolkit/ImageToolkitManager.php, line 19

Namespace

Drupal\Core\ImageToolkit
View source
class ImageToolkitManager extends DefaultPluginManager {
    
    /**
     * The config factory.
     *
     * @var \Drupal\Core\Config\ConfigFactoryInterface
     */
    protected $configFactory;
    
    /**
     * Constructs the ImageToolkitManager 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.
     * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
     *   The config factory.
     */
    public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, ConfigFactoryInterface $config_factory) {
        parent::__construct('Plugin/ImageToolkit', $namespaces, $module_handler, ImageToolkitInterface::class, ImageToolkit::class, 'Drupal\\Core\\ImageToolkit\\Annotation\\ImageToolkit');
        $this->setCacheBackend($cache_backend, 'image_toolkit_plugins');
        $this->configFactory = $config_factory;
    }
    
    /**
     * Gets the default image toolkit ID.
     *
     * @return string|bool
     *   ID of the default toolkit, or FALSE on error.
     */
    public function getDefaultToolkitId() {
        $toolkit_id = $this->configFactory
            ->get('system.image')
            ->get('toolkit');
        $toolkits = $this->getAvailableToolkits();
        if (!isset($toolkits[$toolkit_id]) || !class_exists($toolkits[$toolkit_id]['class'])) {
            // The selected toolkit isn't available so return the first one found. If
            // none are available this will return FALSE.
            $toolkit_id = array_key_first($toolkits);
        }
        return $toolkit_id;
    }
    
    /**
     * Gets the default image toolkit.
     *
     * @return \Drupal\Core\ImageToolkit\ImageToolkitInterface
     *   Object of the default toolkit, or FALSE on error.
     */
    public function getDefaultToolkit() {
        if ($toolkit_id = $this->getDefaultToolkitId()) {
            return $this->createInstance($toolkit_id);
        }
        return FALSE;
    }
    
    /**
     * Gets a list of available toolkits.
     *
     * @return array
     *   An array with the toolkit names as keys and the descriptions as values.
     */
    public function getAvailableToolkits() {
        // Use plugin system to get list of available toolkits.
        $toolkits = $this->getDefinitions();
        $output = [];
        foreach ($toolkits as $id => $definition) {
            // Only allow modules that aren't marked as unavailable.
            if (call_user_func($definition['class'] . '::isAvailable')) {
                $output[$id] = $definition;
            }
        }
        return $output;
    }
    
    /**
     * Returns all valid extensions.
     *
     * @return string[]
     *   All possible valid extensions.
     *
     * @see \Drupal\image\Plugin\ImageEffect\ConvertImageEffect::buildConfigurationForm()
     *
     * @internal
     * @todo Revisit in https://www.drupal.org/node/3446364
     */
    public static function getAllValidExtensions() : array {
        return \Drupal::service('image.toolkit.manager')->getDefaultToolkit()
            ->getSupportedExtensions();
    }

}

Members

Title Sort descending 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(). 10
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 9
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 1
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. 14
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
ImageToolkitManager::$configFactory protected property The config factory.
ImageToolkitManager::getAllValidExtensions public static function Returns all valid extensions.
ImageToolkitManager::getAvailableToolkits public function Gets a list of available toolkits.
ImageToolkitManager::getDefaultToolkit public function Gets the default image toolkit.
ImageToolkitManager::getDefaultToolkitId public function Gets the default image toolkit ID.
ImageToolkitManager::__construct public function Constructs the ImageToolkitManager 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 object that returns the preconfigured plugin instance appropriate for a particular runtime condition.
PluginManagerBase::createInstance public function 14
PluginManagerBase::getFallbackPluginId protected function Gets a fallback id for a missing plugin. 5
PluginManagerBase::getInstance public function 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.
RSS feed
Powered by Drupal