class Crop in Drupal 8
Same name and namespace in other branches
- 9 core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Crop.php \Drupal\system\Plugin\ImageToolkit\Operation\gd\Crop
Defines GD2 Crop operation.
Plugin annotation
@ImageToolkitOperation(
id = "gd_crop",
toolkit = "gd",
operation = "crop",
label = @Translation("Crop"),
description = @Translation("Crops an image to a rectangle specified by the given dimensions.")
)
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\Crop
- 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 Crop
3 string references to 'Crop'
- ImageTest::testCrop in core/
tests/ Drupal/ Tests/ Core/ Image/ ImageTest.php - Tests \Drupal\Core\Image\Image::crop().
- ImageTest::testCropHeight in core/
tests/ Drupal/ Tests/ Core/ Image/ ImageTest.php - Tests \Drupal\Core\Image\Image::crop().
- ImageTest::testCropWidth in core/
tests/ Drupal/ Tests/ Core/ Image/ ImageTest.php - Tests \Drupal\Core\Image\Image::crop().
File
- core/
modules/ system/ src/ Plugin/ ImageToolkit/ Operation/ gd/ Crop.php, line 16
Namespace
Drupal\system\Plugin\ImageToolkit\Operation\gdView source
class Crop extends GDImageToolkitOperationBase {
/**
* {@inheritdoc}
*/
protected function arguments() {
return [
'x' => [
'description' => 'The starting x offset at which to start the crop, in pixels',
],
'y' => [
'description' => 'The starting y offset at which to start the crop, in pixels',
],
'width' => [
'description' => 'The width of the cropped area, in pixels',
'required' => FALSE,
'default' => NULL,
],
'height' => [
'description' => 'The height of the cropped area, in pixels',
'required' => FALSE,
'default' => NULL,
],
];
}
/**
* {@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 'crop' operation");
}
// Preserve aspect.
$aspect = $this
->getToolkit()
->getHeight() / $this
->getToolkit()
->getWidth();
$arguments['height'] = empty($arguments['height']) ? $arguments['width'] * $aspect : $arguments['height'];
$arguments['width'] = empty($arguments['width']) ? $arguments['height'] / $aspect : $arguments['width'];
// Assure integers for all arguments.
foreach ([
'x',
'y',
'width',
'height',
] as $key) {
$arguments[$key] = (int) round($arguments[$key]);
}
// Fail when width or height are 0 or negative.
if ($arguments['width'] <= 0) {
throw new \InvalidArgumentException("Invalid width ('{$arguments['width']}') specified for the image 'crop' operation");
}
if ($arguments['height'] <= 0) {
throw new \InvalidArgumentException("Invalid height ('{$arguments['height']}') specified for the image 'crop' operation");
}
return $arguments;
}
/**
* {@inheritdoc}
*/
protected function execute(array $arguments) {
// Create a new resource of the required dimensions, and copy and resize
// the original resource on it with resampling. Destroy the original
// resource upon success.
$original_resource = $this
->getToolkit()
->getResource();
$data = [
'width' => $arguments['width'],
'height' => $arguments['height'],
'extension' => image_type_to_extension($this
->getToolkit()
->getType(), FALSE),
'transparent_color' => $this
->getToolkit()
->getTransparentColor(),
'is_temp' => TRUE,
];
if ($this
->getToolkit()
->apply('create_new', $data)) {
if (imagecopyresampled($this
->getToolkit()
->getResource(), $original_resource, 0, 0, $arguments['x'], $arguments['y'], $arguments['width'], $arguments['height'], $arguments['width'], $arguments['height'])) {
imagedestroy($original_resource);
return TRUE;
}
else {
// In case of failure, destroy the temporary resource and restore
// the original one.
imagedestroy($this
->getToolkit()
->getResource());
$this
->getToolkit()
->setResource($original_resource);
}
}
return FALSE;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Crop:: |
protected | function |
Returns the definition of the operation arguments. Overrides ImageToolkitOperationBase:: |
|
Crop:: |
protected | function |
Performs the actual manipulation on the image. Overrides ImageToolkitOperationBase:: |
|
Crop:: |
protected | function |
Validates the arguments. Overrides ImageToolkitOperationBase:: |
|
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:: |
|
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. | |
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. |