class ResizeImageEffect
Same name and namespace in other branches
- 11.x core/modules/image/src/Plugin/ImageEffect/ResizeImageEffect.php \Drupal\image\Plugin\ImageEffect\ResizeImageEffect
- 10 core/modules/image/src/Plugin/ImageEffect/ResizeImageEffect.php \Drupal\image\Plugin\ImageEffect\ResizeImageEffect
- 8.9.x core/modules/image/src/Plugin/ImageEffect/ResizeImageEffect.php \Drupal\image\Plugin\ImageEffect\ResizeImageEffect
Resizes an image resource.
Plugin annotation
@ImageEffect(
id = "image_resize",
label = @Translation("Resize"),
description = @Translation("Resizing will make images an exact set of dimensions. This may cause images to be stretched or shrunk disproportionately.")
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
- class \Drupal\image\ImageEffectBase implements \Drupal\image\ImageEffectInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\image\ConfigurableImageEffectBase implements \Drupal\image\ConfigurableImageEffectInterface extends \Drupal\image\ImageEffectBase
- class \Drupal\image\Plugin\ImageEffect\ResizeImageEffect extends \Drupal\image\ConfigurableImageEffectBase
- class \Drupal\image\ConfigurableImageEffectBase implements \Drupal\image\ConfigurableImageEffectInterface extends \Drupal\image\ImageEffectBase
- class \Drupal\image\ImageEffectBase implements \Drupal\image\ImageEffectInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of ResizeImageEffect
File
-
core/
modules/ image/ src/ Plugin/ ImageEffect/ ResizeImageEffect.php, line 18
Namespace
Drupal\image\Plugin\ImageEffectView source
class ResizeImageEffect extends ConfigurableImageEffectBase {
/**
* {@inheritdoc}
*/
public function applyEffect(ImageInterface $image) {
if (!$image->resize($this->configuration['width'], $this->configuration['height'])) {
$this->logger
->error('Image resize failed using the %toolkit toolkit on %path (%mimetype, %dimensions)', [
'%toolkit' => $image->getToolkitId(),
'%path' => $image->getSource(),
'%mimetype' => $image->getMimeType(),
'%dimensions' => $image->getWidth() . 'x' . $image->getHeight(),
]);
return FALSE;
}
return TRUE;
}
/**
* {@inheritdoc}
*/
public function transformDimensions(array &$dimensions, $uri) {
// The new image will have the exact dimensions defined for the effect.
$dimensions['width'] = $this->configuration['width'];
$dimensions['height'] = $this->configuration['height'];
}
/**
* {@inheritdoc}
*/
public function getSummary() {
$summary = [
'#theme' => 'image_resize_summary',
'#data' => $this->configuration,
];
$summary += parent::getSummary();
return $summary;
}
/**
* {@inheritdoc}
*/
public function defaultConfiguration() {
return [
'width' => NULL,
'height' => NULL,
];
}
/**
* {@inheritdoc}
*/
public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
$form['width'] = [
'#type' => 'number',
'#title' => $this->t('Width'),
'#default_value' => $this->configuration['width'],
'#field_suffix' => ' ' . $this->t('pixels'),
'#required' => TRUE,
'#min' => 1,
];
$form['height'] = [
'#type' => 'number',
'#title' => $this->t('Height'),
'#default_value' => $this->configuration['height'],
'#field_suffix' => ' ' . $this->t('pixels'),
'#required' => TRUE,
'#min' => 1,
];
return $form;
}
/**
* {@inheritdoc}
*/
public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
parent::submitConfigurationForm($form, $form_state);
$this->configuration['height'] = $form_state->getValue('height');
$this->configuration['width'] = $form_state->getValue('width');
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ConfigurableImageEffectBase::validateConfigurationForm | public | function | |||
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 | |||
DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | ||
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 | |||
ImageEffectBase::create | public static | function | |||
ImageEffectBase::getConfiguration | public | function | |||
ImageEffectBase::getDerivativeExtension | public | function | |||
ImageEffectBase::getUuid | public | function | |||
ImageEffectBase::getWeight | public | function | |||
ImageEffectBase::label | public | function | |||
ImageEffectBase::setConfiguration | public | function | |||
ImageEffectBase::setWeight | public | function | |||
ImageEffectBase::__construct | public | function | |||
MessengerTrait::$messenger | protected | property | The messenger. | 7 | |
MessengerTrait::$messenger | protected | property | The messenger. | 7 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 7 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 7 | |
MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | ||
PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | ||
PluginBase::$pluginId | protected | property | The plugin_id. | ||
PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | |||
PluginBase::getBaseId | public | function | |||
PluginBase::getDerivativeId | public | function | |||
PluginBase::getPluginDefinition | public | function | 1 | ||
PluginBase::getPluginDefinition | public | function | 1 | ||
PluginBase::getPluginId | public | function | |||
PluginBase::isConfigurable | public | function | Determines if the plugin is configurable. | ||
ResizeImageEffect::applyEffect | public | function | Applies an image effect to the image object. | Overrides ImageEffectInterface::applyEffect | |
ResizeImageEffect::buildConfigurationForm | public | function | Form constructor. | Overrides PluginFormInterface::buildConfigurationForm | |
ResizeImageEffect::defaultConfiguration | public | function | Gets default configuration for this plugin. | Overrides ImageEffectBase::defaultConfiguration | |
ResizeImageEffect::getSummary | public | function | Returns a render array summarizing the configuration of the image effect. | Overrides ImageEffectBase::getSummary | |
ResizeImageEffect::submitConfigurationForm | public | function | Form submission handler. | Overrides ConfigurableImageEffectBase::submitConfigurationForm | |
ResizeImageEffect::transformDimensions | public | function | Determines the dimensions of the styled image. | Overrides ImageEffectBase::transformDimensions | |
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | ||
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. | ||
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.