class Scale in Imagick 8
Defines imagick scale operation.
Plugin annotation
@ImageToolkitOperation(
id = "imagick_scale",
toolkit = "imagick",
operation = "scale",
label = @Translation("Scale"),
description = @Translation("Scale an image to the given dimensions (ignoring aspect ratio).")
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\ImageToolkit\ImageToolkitOperationBase implements ImageToolkitOperationInterface
- class \Drupal\system\Plugin\ImageToolkit\Operation\gd\GDImageToolkitOperationBase
- class \Drupal\system\Plugin\ImageToolkit\Operation\gd\Resize
- class \Drupal\imagick\Plugin\ImageToolkit\Operation\imagick\Resize uses ImagickOperationTrait
- class \Drupal\imagick\Plugin\ImageToolkit\Operation\imagick\Scale
- class \Drupal\imagick\Plugin\ImageToolkit\Operation\imagick\Resize uses ImagickOperationTrait
- class \Drupal\system\Plugin\ImageToolkit\Operation\gd\Resize
- class \Drupal\system\Plugin\ImageToolkit\Operation\gd\GDImageToolkitOperationBase
- class \Drupal\Core\ImageToolkit\ImageToolkitOperationBase implements ImageToolkitOperationInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of Scale
File
- src/
Plugin/ ImageToolkit/ Operation/ imagick/ Scale.php, line 16
Namespace
Drupal\imagick\Plugin\ImageToolkit\Operation\imagickView source
class Scale extends Resize {
/**
* {@inheritdoc}
*/
protected function validateArguments(array $arguments) {
// Assure at least one dimension.
if (empty($arguments['width']) && empty($arguments['height'])) {
throw new \InvalidArgumentException("At least one dimension ('width' or 'height') must be provided to the image 'scale' operation");
}
// Calculate one of the dimensions from the other target dimension,
// ensuring the same aspect ratio as the source dimensions. If one of the
// target dimensions is missing, that is the one that is calculated. If both
// are specified then the dimension calculated is the one that would not be
// calculated to be bigger than its target.
$aspect = $this
->getToolkit()
->getHeight() / $this
->getToolkit()
->getWidth();
if ($arguments['width'] && !$arguments['height'] || $arguments['width'] && $arguments['height'] && $aspect < $arguments['height'] / $arguments['width']) {
$arguments['height'] = (int) round($arguments['width'] * $aspect);
}
else {
$arguments['width'] = (int) round($arguments['height'] / $aspect);
}
// Assure integers for all arguments.
$arguments['width'] = (int) round($arguments['width']);
$arguments['height'] = (int) round($arguments['height']);
// Fail when width or height are 0 or negative.
if ($arguments['width'] <= 0) {
throw new \InvalidArgumentException($this
->t("Invalid width (@value) specified for the image 'scale' operation", [
'@value' => $arguments['width'],
]));
}
if ($arguments['height'] <= 0) {
throw new \InvalidArgumentException($this
->t("Invalid height (@value) specified for the image 'scale' operation", [
'@value' => $arguments['height'],
]));
}
return $arguments;
}
/**
* {@inheritdoc}
*/
protected function execute(array $arguments = []) {
// Don't scale if we don't change the dimensions at all.
if ($arguments['width'] !== $this
->getToolkit()
->getWidth() || $arguments['height'] !== $this
->getToolkit()
->getHeight()) {
// Don't upscale if the option isn't enabled.
if ($arguments['upscale'] || $arguments['width'] <= $this
->getToolkit()
->getWidth() && $arguments['height'] <= $this
->getToolkit()
->getHeight()) {
return parent::execute($arguments);
}
}
return TRUE;
}
}
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 | |
GDImageToolkitOperationBase:: |
protected | function |
The correctly typed image toolkit for GD operations. Overrides ImageToolkitOperationBase:: |
|
ImageToolkitOperationBase:: |
protected | property | A logger instance. | |
ImageToolkitOperationBase:: |
protected | property | The image toolkit. | |
ImageToolkitOperationBase:: |
final public | function |
Applies a toolkit specific operation to an image. Overrides ImageToolkitOperationInterface:: |
|
ImageToolkitOperationBase:: |
protected | function | Checks if required arguments are passed in and adds defaults for non passed in optional arguments. | |
ImageToolkitOperationBase:: |
public | function |
Constructs an image toolkit operation plugin. Overrides PluginBase:: |
|
ImagickOperationTrait:: |
protected | function | Process image frames for GIFs | |
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. | |
Resize:: |
protected | function |
Returns the definition of the operation arguments. Overrides ImageToolkitOperationBase:: |
1 |
Resize:: |
protected | function | ||
Scale:: |
protected | function |
Performs the actual manipulation on the image. Overrides Resize:: |
|
Scale:: |
protected | function |
Validates the arguments. Overrides Resize:: |
|
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. |