class ConvertImageEffect

Same name and namespace in other branches
  1. 11.x core/modules/image/src/Plugin/ImageEffect/ConvertImageEffect.php \Drupal\image\Plugin\ImageEffect\ConvertImageEffect
  2. 10 core/modules/image/src/Plugin/ImageEffect/ConvertImageEffect.php \Drupal\image\Plugin\ImageEffect\ConvertImageEffect
  3. 9 core/modules/image/src/Plugin/ImageEffect/ConvertImageEffect.php \Drupal\image\Plugin\ImageEffect\ConvertImageEffect
  4. 8.9.x core/modules/image/src/Plugin/ImageEffect/ConvertImageEffect.php \Drupal\image\Plugin\ImageEffect\ConvertImageEffect

Converts an image resource.

Attributes

#[ImageEffect(id: "image_convert", label: new TranslatableMarkup("Convert"), description: new TranslatableMarkup("Converts an image to a format (such as JPEG)."))]

Hierarchy

Expanded class hierarchy of ConvertImageEffect

File

core/modules/image/src/Plugin/ImageEffect/ConvertImageEffect.php, line 14

Namespace

Drupal\image\Plugin\ImageEffect
View source
class ConvertImageEffect extends ConfigurableImageEffectBase {
  
  /**
   * {@inheritdoc}
   */
  public function applyEffect(ImageInterface $image) {
    if (!$image->convert($this->configuration['extension'])) {
      $this->logger
        ->error('Image convert failed using the %toolkit toolkit on %path (%mimetype)', [
        '%toolkit' => $image->getToolkitId(),
        '%path' => $image->getSource(),
        '%mimetype' => $image->getMimeType(),
      ]);
      return FALSE;
    }
    return TRUE;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getDerivativeExtension($extension) {
    return $this->configuration['extension'];
  }
  
  /**
   * {@inheritdoc}
   */
  public function getSummary() {
    $summary = [
      '#markup' => mb_strtoupper($this->configuration['extension']),
    ];
    $summary += parent::getSummary();
    return $summary;
  }
  
  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'extension' => NULL,
    ];
  }
  
  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $extensions = \Drupal::service('image.toolkit.manager')->getDefaultToolkit()
      ->getSupportedExtensions();
    $options = array_combine($extensions, array_map('mb_strtoupper', $extensions));
    $form['extension'] = [
      '#type' => 'select',
      '#title' => $this->t('Convert to'),
      '#default_value' => $this->configuration['extension'],
      '#required' => TRUE,
      '#options' => $options,
    ];
    return $form;
  }
  
  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this->configuration['extension'] = $form_state->getValue('extension');
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
AutowiredInstanceTrait::createInstanceAutowired public static function Instantiates a new instance of the implementing class using autowiring.
AutowiredInstanceTrait::getAutowireArguments private static function Resolves arguments for a method using autowiring.
ConfigurableImageEffectBase::validateConfigurationForm public function Overrides PluginFormInterface::validateConfigurationForm 2
ConfigurableTrait::$configuration protected property Configuration information passed into the plugin.
ConvertImageEffect::applyEffect public function Overrides ImageEffectInterface::applyEffect 1
ConvertImageEffect::buildConfigurationForm public function Overrides PluginFormInterface::buildConfigurationForm 1
ConvertImageEffect::defaultConfiguration public function Overrides ConfigurableTrait::defaultConfiguration
ConvertImageEffect::getDerivativeExtension public function Overrides ImageEffectBase::getDerivativeExtension 1
ConvertImageEffect::getSummary public function Overrides ImageEffectBase::getSummary
ConvertImageEffect::submitConfigurationForm public function Overrides ConfigurableImageEffectBase::submitConfigurationForm
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
ImageEffectBase::$logger protected property A logger instance.
ImageEffectBase::$uuid protected property The image effect ID.
ImageEffectBase::$weight protected property The weight of the image effect.
ImageEffectBase::calculateDependencies public function Overrides DependentPluginInterface::calculateDependencies
ImageEffectBase::getConfiguration public function Overrides ConfigurableTrait::getConfiguration
ImageEffectBase::getUuid public function Overrides ImageEffectInterface::getUuid
ImageEffectBase::getWeight public function Overrides ImageEffectInterface::getWeight
ImageEffectBase::label public function Overrides ImageEffectInterface::label
ImageEffectBase::onCollectionDependencyRemoval public function Overrides RemovableDependentPluginInterface::onCollectionDependencyRemoval
ImageEffectBase::setConfiguration public function Overrides ConfigurableTrait::setConfiguration
ImageEffectBase::setWeight public function Overrides ImageEffectInterface::setWeight
ImageEffectBase::transformDimensions public function Overrides ImageEffectInterface::transformDimensions 4
ImageEffectBase::__construct public function Overrides ConfigurablePluginBase::__construct
MessengerTrait::$messenger protected property The messenger. 25
MessengerTrait::messenger public function Gets the messenger. 25
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin ID.
PluginBase::create public static function Instantiates a new instance of the implementing class using autowiring. 64
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Overrides PluginInspectionInterface::getPluginId
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. 1

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.