Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\image;
Chris@0: 
Chris@0: use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
Chris@0: use Drupal\Core\Plugin\PluginBase;
Chris@0: use Psr\Log\LoggerInterface;
Chris@0: use Symfony\Component\DependencyInjection\ContainerInterface;
Chris@0: 
Chris@0: /**
Chris@0:  * Provides a base class for image effects.
Chris@0:  *
Chris@0:  * @see \Drupal\image\Annotation\ImageEffect
Chris@0:  * @see \Drupal\image\ImageEffectInterface
Chris@0:  * @see \Drupal\image\ConfigurableImageEffectInterface
Chris@0:  * @see \Drupal\image\ConfigurableImageEffectBase
Chris@0:  * @see \Drupal\image\ImageEffectManager
Chris@0:  * @see plugin_api
Chris@0:  */
Chris@0: abstract class ImageEffectBase extends PluginBase implements ImageEffectInterface, ContainerFactoryPluginInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * The image effect ID.
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   protected $uuid;
Chris@0: 
Chris@0:   /**
Chris@0:    * The weight of the image effect.
Chris@0:    *
Chris@0:    * @var int|string
Chris@0:    */
Chris@0:   protected $weight = '';
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:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function __construct(array $configuration, $plugin_id, $plugin_definition, LoggerInterface $logger) {
Chris@0:     parent::__construct($configuration, $plugin_id, $plugin_definition);
Chris@0: 
Chris@0:     $this->setConfiguration($configuration);
Chris@0:     $this->logger = $logger;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
Chris@0:     return new static(
Chris@0:       $configuration,
Chris@0:       $plugin_id,
Chris@0:       $plugin_definition,
Chris@0:       $container->get('logger.factory')->get('image')
Chris@0:     );
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function transformDimensions(array &$dimensions, $uri) {
Chris@0:     // Most image effects will not change the dimensions. This base
Chris@0:     // implementation represents this behavior. Override this method if your
Chris@0:     // image effect does change the dimensions.
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getDerivativeExtension($extension) {
Chris@0:     // Most image effects will not change the extension. This base
Chris@0:     // implementation represents this behavior. Override this method if your
Chris@0:     // image effect does change the extension.
Chris@0:     return $extension;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getSummary() {
Chris@0:     return [
Chris@0:       '#markup' => '',
Chris@0:       '#effect' => [
Chris@0:         'id' => $this->pluginDefinition['id'],
Chris@0:         'label' => $this->label(),
Chris@0:         'description' => $this->pluginDefinition['description'],
Chris@0:       ],
Chris@0:     ];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function label() {
Chris@0:     return $this->pluginDefinition['label'];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getUuid() {
Chris@0:     return $this->uuid;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function setWeight($weight) {
Chris@0:     $this->weight = $weight;
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getWeight() {
Chris@0:     return $this->weight;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getConfiguration() {
Chris@0:     return [
Chris@0:       'uuid' => $this->getUuid(),
Chris@0:       'id' => $this->getPluginId(),
Chris@0:       'weight' => $this->getWeight(),
Chris@0:       'data' => $this->configuration,
Chris@0:     ];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function setConfiguration(array $configuration) {
Chris@0:     $configuration += [
Chris@0:       'data' => [],
Chris@0:       'uuid' => '',
Chris@0:       'weight' => '',
Chris@0:     ];
Chris@0:     $this->configuration = $configuration['data'] + $this->defaultConfiguration();
Chris@0:     $this->uuid = $configuration['uuid'];
Chris@0:     $this->weight = $configuration['weight'];
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function defaultConfiguration() {
Chris@0:     return [];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function calculateDependencies() {
Chris@0:     return [];
Chris@0:   }
Chris@0: 
Chris@0: }