class ConvertImageEffect

Same name in other branches
  1. 8.9.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. 11.x core/modules/image/src/Plugin/ImageEffect/ConvertImageEffect.php \Drupal\image\Plugin\ImageEffect\ConvertImageEffect

Converts an image resource.

Plugin annotation


@ImageEffect(
  id = "image_convert",
  label = @Translation("Convert"),
  description = @Translation("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 18

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 Modifiers Object type Summary Overriden Title Overrides
ConfigurableImageEffectBase::validateConfigurationForm public function 2
ConvertImageEffect::applyEffect public function Applies an image effect to the image object. Overrides ImageEffectInterface::applyEffect
ConvertImageEffect::buildConfigurationForm public function
ConvertImageEffect::defaultConfiguration public function Gets default configuration for this plugin. Overrides ImageEffectBase::defaultConfiguration
ConvertImageEffect::getDerivativeExtension public function Returns the extension of the derivative after applying this image effect. Overrides ImageEffectBase::getDerivativeExtension
ConvertImageEffect::getSummary public function Returns a render array summarizing the configuration of the image effect. Overrides ImageEffectBase::getSummary
ConvertImageEffect::submitConfigurationForm public function Overrides ConfigurableImageEffectBase::submitConfigurationForm
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 Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ImageEffectBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ImageEffectBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ImageEffectBase::getUuid public function Returns the unique ID representing the image effect. Overrides ImageEffectInterface::getUuid
ImageEffectBase::getWeight public function Returns the weight of the image effect. Overrides ImageEffectInterface::getWeight
ImageEffectBase::label public function Returns the image effect label. Overrides ImageEffectInterface::label
ImageEffectBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ImageEffectBase::setWeight public function Sets the weight for this image effect. Overrides ImageEffectInterface::setWeight
ImageEffectBase::transformDimensions public function Determines the dimensions of the styled image. Overrides ImageEffectInterface::transformDimensions 4
ImageEffectBase::__construct public function
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2

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