class ResizePercentageImageEffect in Image Effects 8
Same name and namespace in other branches
- 8.3 src/Plugin/ImageEffect/ResizePercentageImageEffect.php \Drupal\image_effects\Plugin\ImageEffect\ResizePercentageImageEffect
- 8.2 src/Plugin/ImageEffect/ResizePercentageImageEffect.php \Drupal\image_effects\Plugin\ImageEffect\ResizePercentageImageEffect
Resize an image by percentage.
Plugin annotation
@ImageEffect(
id = "image_effects_resize_percentage",
label = @Translation("Resize percentage"),
description = @Translation("Resize the image by percentage of its width/height. If only a single dimension is specified, the other dimension will be calculated, maintaining the aspect ratio (scale).")
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\image\ImageEffectBase implements ContainerFactoryPluginInterface, ImageEffectInterface
- class \Drupal\image\ConfigurableImageEffectBase implements ConfigurableImageEffectInterface
- class \Drupal\image_effects\Plugin\ImageEffect\ResizePercentageImageEffect
- class \Drupal\image\ConfigurableImageEffectBase implements ConfigurableImageEffectInterface
- class \Drupal\image\ImageEffectBase implements ContainerFactoryPluginInterface, ImageEffectInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of ResizePercentageImageEffect
File
- src/
Plugin/ ImageEffect/ ResizePercentageImageEffect.php, line 19
Namespace
Drupal\image_effects\Plugin\ImageEffectView source
class ResizePercentageImageEffect extends ConfigurableImageEffectBase {
/**
* {@inheritdoc}
*/
public function defaultConfiguration() {
return [
'width' => NULL,
'height' => NULL,
];
}
/**
* {@inheritdoc}
*/
public function getSummary() {
return [
'#theme' => 'image_effects_resize_percentage_summary',
'#data' => $this->configuration,
] + parent::getSummary();
}
/**
* {@inheritdoc}
*/
public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
$form['width'] = [
'#type' => 'image_effects_px_perc',
'#title' => $this
->t('Width'),
'#default_value' => $this->configuration['width'],
'#description' => $this
->t('Enter a value, and specify if pixels or percent. Leave blank to scale according to new height.'),
'#size' => 5,
'#maxlength' => 5,
'#required' => FALSE,
];
$form['height'] = [
'#type' => 'image_effects_px_perc',
'#title' => $this
->t('Height'),
'#default_value' => $this->configuration['height'],
'#description' => $this
->t('Enter a value, and specify if pixels or percent. Leave blank to scale according to new width.'),
'#size' => 5,
'#maxlength' => 5,
'#required' => FALSE,
];
return $form;
}
/**
* {@inheritdoc}
*/
public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
parent::submitConfigurationForm($form, $form_state);
$this->configuration['width'] = $form_state
->getValue('width');
$this->configuration['height'] = $form_state
->getValue('height');
}
/**
* {@inheritdoc}
*/
public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
parent::validateConfigurationForm($form, $form_state);
$width = (bool) $form_state
->getValue('width');
$height = (bool) $form_state
->getValue('height');
if ($width === FALSE && $height === FALSE) {
$form_state
->setError($form, $this
->t("Either <em>Width</em> or <em>Height</em> must be specified."));
}
}
/**
* {@inheritdoc}
*/
public function transformDimensions(array &$dimensions, $uri) {
$d = ImageUtility::resizeDimensions($dimensions['width'], $dimensions['height'], $this->configuration['width'], $this->configuration['height']);
$dimensions['width'] = $d['width'];
$dimensions['height'] = $d['height'];
}
/**
* {@inheritdoc}
*/
public function applyEffect(ImageInterface $image) {
// Get resulting dimensions.
$dimensions = ImageUtility::resizeDimensions($image
->getWidth(), $image
->getHeight(), $this->configuration['width'], $this->configuration['height']);
return $image
->resize($dimensions['width'], $dimensions['height']);
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
ImageEffectBase:: |
protected | property | A logger instance. | |
ImageEffectBase:: |
protected | property | The image effect ID. | |
ImageEffectBase:: |
protected | property | The weight of the image effect. | |
ImageEffectBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
|
ImageEffectBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
|
ImageEffectBase:: |
public | function |
Gets this plugin's configuration. Overrides ConfigurableInterface:: |
|
ImageEffectBase:: |
public | function |
Returns the extension of the derivative after applying this image effect. Overrides ImageEffectInterface:: |
1 |
ImageEffectBase:: |
public | function |
Returns the unique ID representing the image effect. Overrides ImageEffectInterface:: |
|
ImageEffectBase:: |
public | function |
Returns the weight of the image effect. Overrides ImageEffectInterface:: |
|
ImageEffectBase:: |
public | function |
Returns the image effect label. Overrides ImageEffectInterface:: |
|
ImageEffectBase:: |
public | function |
Sets the configuration for this plugin instance. Overrides ConfigurableInterface:: |
|
ImageEffectBase:: |
public | function |
Sets the weight for this image effect. Overrides ImageEffectInterface:: |
|
ImageEffectBase:: |
public | function |
Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase:: |
|
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
ResizePercentageImageEffect:: |
public | function |
Applies an image effect to the image object. Overrides ImageEffectInterface:: |
|
ResizePercentageImageEffect:: |
public | function |
Form constructor. Overrides PluginFormInterface:: |
|
ResizePercentageImageEffect:: |
public | function |
Gets default configuration for this plugin. Overrides ImageEffectBase:: |
|
ResizePercentageImageEffect:: |
public | function |
Returns a render array summarizing the configuration of the image effect. Overrides ImageEffectBase:: |
|
ResizePercentageImageEffect:: |
public | function |
Form submission handler. Overrides ConfigurableImageEffectBase:: |
|
ResizePercentageImageEffect:: |
public | function |
Determines the dimensions of the styled image. Overrides ImageEffectBase:: |
|
ResizePercentageImageEffect:: |
public | function |
Form validation handler. Overrides ConfigurableImageEffectBase:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |