ConvertImageEffect.php
Same filename in other branches
Namespace
Drupal\image\Plugin\ImageEffectFile
-
core/
modules/ image/ src/ Plugin/ ImageEffect/ ConvertImageEffect.php
View source
<?php
namespace Drupal\image\Plugin\ImageEffect;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Image\ImageInterface;
use Drupal\image\ConfigurableImageEffectBase;
/**
* Converts an image resource.
*
* @ImageEffect(
* id = "image_convert",
* label = @Translation("Convert"),
* description = @Translation("Converts an image to a format (such as JPEG).")
* )
*/
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');
}
}
Classes
Title | Deprecated | Summary |
---|---|---|
ConvertImageEffect | Converts an image resource. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.