class CropImageEffect
Same name and namespace in other branches
- 8.9.x core/modules/image/src/Plugin/ImageEffect/CropImageEffect.php \Drupal\image\Plugin\ImageEffect\CropImageEffect
- 10 core/modules/image/src/Plugin/ImageEffect/CropImageEffect.php \Drupal\image\Plugin\ImageEffect\CropImageEffect
- 11.x core/modules/image/src/Plugin/ImageEffect/CropImageEffect.php \Drupal\image\Plugin\ImageEffect\CropImageEffect
Crops an image resource.
Plugin annotation
@ImageEffect(
id = "image_crop",
label = @Translation("Crop"),
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 extends \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 implements \Drupal\Component\Plugin\PluginBase
- class \Drupal\image\ImageEffectBase extends \Drupal\image\ImageEffectInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\image\ConfigurableImageEffectBase extends \Drupal\image\ConfigurableImageEffectInterface implements \Drupal\image\ImageEffectBase
- class \Drupal\image\Plugin\ImageEffect\ResizeImageEffect implements \Drupal\image\ConfigurableImageEffectBase
- class \Drupal\image\Plugin\ImageEffect\CropImageEffect implements \Drupal\image\Plugin\ImageEffect\ResizeImageEffect
- class \Drupal\image\Plugin\ImageEffect\ResizeImageEffect implements \Drupal\image\ConfigurableImageEffectBase
- class \Drupal\image\ConfigurableImageEffectBase extends \Drupal\image\ConfigurableImageEffectInterface implements \Drupal\image\ImageEffectBase
- class \Drupal\image\ImageEffectBase extends \Drupal\image\ImageEffectInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of CropImageEffect
File
-
core/
modules/ image/ src/ Plugin/ ImageEffect/ CropImageEffect.php, line 17
Namespace
Drupal\image\Plugin\ImageEffectView source
class CropImageEffect extends ResizeImageEffect {
/**
* {@inheritdoc}
*/
public function applyEffect(ImageInterface $image) {
[
$x,
$y,
] = explode('-', $this->configuration['anchor']);
$x = image_filter_keyword($x, $image->getWidth(), $this->configuration['width']);
$y = image_filter_keyword($y, $image->getHeight(), $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');
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ConfigurableImageEffectBase::validateConfigurationForm | public | function | Form validation handler. | Overrides PluginFormInterface::validateConfigurationForm | 2 |
CropImageEffect::applyEffect | public | function | Applies an image effect to the image object. | Overrides ResizeImageEffect::applyEffect | 1 |
CropImageEffect::buildConfigurationForm | public | function | Form constructor. | Overrides ResizeImageEffect::buildConfigurationForm | |
CropImageEffect::defaultConfiguration | public | function | Gets default configuration for this plugin. | Overrides ResizeImageEffect::defaultConfiguration | |
CropImageEffect::getSummary | public | function | Returns a render array summarizing the configuration of the image effect. | Overrides ResizeImageEffect::getSummary | 1 |
CropImageEffect::submitConfigurationForm | public | function | Form submission handler. | Overrides ResizeImageEffect::submitConfigurationForm | |
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 | 2 | ||
DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 2 | |
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 | Calculates dependencies for the configured plugin. | Overrides DependentPluginInterface::calculateDependencies | |
ImageEffectBase::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | |
ImageEffectBase::getConfiguration | public | function | Gets this plugin's configuration. | Overrides ConfigurableInterface::getConfiguration | |
ImageEffectBase::getDerivativeExtension | public | function | Returns the extension of the derivative after applying this image effect. | Overrides ImageEffectInterface::getDerivativeExtension | 1 |
ImageEffectBase::getUuid | public | function | Returns the unique ID representing the image effect. | Overrides ImageEffectInterface::getUuid | |
ImageEffectBase::getWeight | public | function | Returns the weight of the image effect. | Overrides ImageEffectInterface::getWeight | |
ImageEffectBase::label | public | function | Returns the image effect label. | Overrides ImageEffectInterface::label | |
ImageEffectBase::setConfiguration | public | function | Sets the configuration for this plugin instance. | Overrides ConfigurableInterface::setConfiguration | |
ImageEffectBase::setWeight | public | function | Sets the weight for this image effect. | Overrides ImageEffectInterface::setWeight | |
ImageEffectBase::__construct | public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | Overrides PluginBase::__construct | |
MessengerTrait::$messenger | protected | property | The messenger. | 27 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 27 | |
MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | |
PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | |
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 | Gets the base_plugin_id of the plugin instance. | Overrides DerivativeInspectionInterface::getBaseId | |
PluginBase::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | Overrides DerivativeInspectionInterface::getDerivativeId | |
PluginBase::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | Overrides PluginInspectionInterface::getPluginDefinition | 2 |
PluginBase::getPluginId | public | function | Gets the plugin_id of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | |
PluginBase::isConfigurable | public | function | Determines if the plugin is configurable. | ||
ResizeImageEffect::transformDimensions | public | function | Determines the dimensions of the styled image. | Overrides ImageEffectBase::transformDimensions | 1 |
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |
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. | 2 | |
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.