Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Core\ImageToolkit;
Chris@0: 
Chris@0: use Drupal\Core\Cache\CacheBackendInterface;
Chris@0: use Drupal\Core\Extension\ModuleHandlerInterface;
Chris@0: use Drupal\Core\Plugin\DefaultPluginManager;
Chris@0: use Drupal\Component\Plugin\Exception\PluginNotFoundException;
Chris@0: use Drupal\Component\Plugin\Factory\DefaultFactory;
Chris@17: use Drupal\Component\Render\FormattableMarkup;
Chris@0: use Psr\Log\LoggerInterface;
Chris@0: 
Chris@0: /**
Chris@0:  * Manages toolkit operation plugins.
Chris@0:  *
Chris@0:  * @see \Drupal\Core\ImageToolkit\Annotation\ImageToolkitOperation
Chris@0:  * @see \Drupal\Core\ImageToolkit\ImageToolkitOperationBase
Chris@0:  * @see \Drupal\Core\ImageToolkit\ImageToolkitOperationInterface
Chris@0:  * @see plugin_api
Chris@0:  */
Chris@0: class ImageToolkitOperationManager extends DefaultPluginManager implements ImageToolkitOperationManagerInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * A logger instance.
Chris@0:    *
Chris@0:    * @var \Psr\Log\LoggerInterface
Chris@0:    */
Chris@0:   protected $logger;
Chris@0: 
Chris@0:   /**
Chris@0:    * The image toolkit manager.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\ImageToolkit\ImageToolkitManager
Chris@0:    */
Chris@0:   protected $toolkitManager;
Chris@0: 
Chris@0:   /**
Chris@0:    * Constructs the ImageToolkitOperationManager 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:    * @param \Psr\Log\LoggerInterface $logger
Chris@0:    *   A logger instance.
Chris@0:    * @param \Drupal\Core\ImageToolkit\ImageToolkitManager $toolkit_manager
Chris@0:    *   The image toolkit manager.
Chris@0:    */
Chris@0:   public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, LoggerInterface $logger, ImageToolkitManager $toolkit_manager) {
Chris@0:     parent::__construct('Plugin/ImageToolkit/Operation', $namespaces, $module_handler, 'Drupal\Core\ImageToolkit\ImageToolkitOperationInterface', 'Drupal\Core\ImageToolkit\Annotation\ImageToolkitOperation');
Chris@0: 
Chris@0:     $this->alterInfo('image_toolkit_operation');
Chris@0:     $this->setCacheBackend($cache_backend, 'image_toolkit_operation_plugins');
Chris@0:     $this->logger = $logger;
Chris@0:     $this->toolkitManager = $toolkit_manager;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns the plugin ID for a given toolkit and operation.
Chris@0:    *
Chris@0:    * @param \Drupal\Core\ImageToolkit\ImageToolkitInterface $toolkit
Chris@0:    *   The toolkit instance.
Chris@0:    * @param string $operation
Chris@0:    *   The operation (e.g. "crop").
Chris@0:    *
Chris@0:    * @return string
Chris@0:    *   The plugin ID.
Chris@0:    *
Chris@0:    * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
Chris@0:    *   When no plugin is available.
Chris@0:    */
Chris@0:   protected function getToolkitOperationPluginId(ImageToolkitInterface $toolkit, $operation) {
Chris@0:     $toolkit_id = $toolkit->getPluginId();
Chris@0:     $definitions = $this->getDefinitions();
Chris@0: 
Chris@0:     $definitions = array_filter($definitions,
Chris@0:       function ($definition) use ($toolkit_id, $operation) {
Chris@0:         return $definition['toolkit'] == $toolkit_id && $definition['operation'] == $operation;
Chris@0:       }
Chris@0:     );
Chris@0: 
Chris@0:     if (!$definitions) {
Chris@0:       // If this image toolkit plugin is a derivative and returns no operation,
Chris@0:       // try once again with its base plugin.
Chris@0:       $base_toolkit_id = $toolkit->getBaseId();
Chris@0:       if (($toolkit_id != $base_toolkit_id) && !empty($base_toolkit_id)) {
Chris@0:         $base_toolkit = $this->toolkitManager->createInstance($base_toolkit_id);
Chris@0:         return $this->getToolkitOperationPluginId($base_toolkit, $operation);
Chris@0:       }
Chris@0: 
Chris@17:       $message = new FormattableMarkup("No image operation plugin for '@toolkit' toolkit and '@operation' operation.", ['@toolkit' => $toolkit_id, '@operation' => $operation]);
Chris@0:       throw new PluginNotFoundException($toolkit_id . '.' . $operation, $message);
Chris@0:     }
Chris@0:     else {
Chris@0:       // Pickup the first plugin found.
Chris@0:       // @todo In https://www.drupal.org/node/2110591 we'll return here the UI
Chris@0:       //   selected plugin or the first found if missed.
Chris@0:       $definition = reset($definitions);
Chris@0:       return $definition['id'];
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function createInstance($plugin_id, array $configuration = [], ImageToolkitInterface $toolkit = NULL) {
Chris@0:     $plugin_definition = $this->getDefinition($plugin_id);
Chris@0:     $plugin_class = DefaultFactory::getPluginClass($plugin_id, $plugin_definition);
Chris@0:     return new $plugin_class($configuration, $plugin_id, $plugin_definition, $toolkit, $this->logger);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getToolkitOperation(ImageToolkitInterface $toolkit, $operation) {
Chris@0:     $plugin_id = $this->getToolkitOperationPluginId($toolkit, $operation);
Chris@0:     return $this->createInstance($plugin_id, [], $toolkit);
Chris@0:   }
Chris@0: 
Chris@0: }