CropImageEffect.php
Same filename in other branches
Namespace
Drupal\image\Plugin\ImageEffectFile
-
core/
modules/ image/ src/ Plugin/ ImageEffect/ CropImageEffect.php
View source
<?php
namespace Drupal\image\Plugin\ImageEffect;
use Drupal\Component\Utility\Image;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Image\ImageInterface;
use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\image\Attribute\ImageEffect;
/**
* Crops an image resource.
*/
class CropImageEffect extends ResizeImageEffect {
/**
* {@inheritdoc}
*/
public function applyEffect(ImageInterface $image) {
[
$x,
$y,
] = explode('-', $this->configuration['anchor']);
$x = Image::getKeywordOffset($x, $image->getWidth(), (int) $this->configuration['width']);
$y = Image::getKeywordOffset($y, $image->getHeight(), (int) $this->configuration['height']);
if (!$image->crop($x, $y, $this->configuration['width'], $this->configuration['height'])) {
$this->logger
->error('Image crop 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 getSummary() {
$summary = [
'#theme' => 'image_crop_summary',
'#data' => $this->configuration,
];
$summary += parent::getSummary();
return $summary;
}
/**
* {@inheritdoc}
*/
public function defaultConfiguration() {
return parent::defaultConfiguration() + [
'anchor' => 'center-center',
];
}
/**
* {@inheritdoc}
*/
public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
$form = parent::buildConfigurationForm($form, $form_state);
$form['anchor'] = [
'#type' => 'radios',
'#title' => $this->t('Anchor'),
'#options' => [
'left-top' => $this->t('Top left'),
'center-top' => $this->t('Top center'),
'right-top' => $this->t('Top right'),
'left-center' => $this->t('Center left'),
'center-center' => $this->t('Center'),
'right-center' => $this->t('Center right'),
'left-bottom' => $this->t('Bottom left'),
'center-bottom' => $this->t('Bottom center'),
'right-bottom' => $this->t('Bottom right'),
],
'#theme' => 'image_anchor',
'#default_value' => $this->configuration['anchor'],
'#description' => $this->t('The part of the image that will be retained during the crop.'),
];
return $form;
}
/**
* {@inheritdoc}
*/
public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
parent::submitConfigurationForm($form, $form_state);
$this->configuration['anchor'] = $form_state->getValue('anchor');
}
}
Classes
Title | Deprecated | Summary |
---|---|---|
CropImageEffect | Crops an image resource. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.