class ScaleAndCropImageEffect in Drupal 9

Scales and crops an image resource.

Plugin annotation

@ImageEffect(
  id = "image_scale_and_crop",
  label = @Translation("Scale and crop"),
  description = @Translation("Scale and crop will maintain the aspect-ratio of the original image, then crop the larger dimension. This is most useful for creating perfectly square thumbnails without stretching the image.")
)

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\Plugin\ImageEffect\ResizeImageEffect
          • class \Drupal\image\Plugin\ImageEffect\CropImageEffect
            • class \Drupal\image\Plugin\ImageEffect\ScaleAndCropImageEffect

File

core/modules/image/src/Plugin/ImageEffect/ScaleAndCropImageEffect.php, line 16

Namespace

Drupal\image\Plugin\ImageEffect

class ScaleAndCropImageEffect extends CropImageEffect {

  /**
   * {@inheritdoc}
   */
  public function applyEffect(ImageInterface $image) {
    $width = $this->configuration['width'];
    $height = $this->configuration['height'];
    $scale = max($width / $image
      ->getWidth(), $height / $image
      ->getHeight());
    list($x, $y) = explode('-', $this->configuration['anchor']);
    $x = image_filter_keyword($x, $image
      ->getWidth() * $scale, $width);
    $y = image_filter_keyword($y, $image
      ->getHeight() * $scale, $height);
    if (!$image
      ->apply('scale_and_crop', [
      'x' => $x,
      'y' => $y,
      'width' => $width,
      'height' => $height,
    ])) {
      $this->logger
        ->error('Image scale and 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_scale_and_crop_summary',
      '#data' => $this->configuration,
    ];
    $summary += parent::getSummary();
    return $summary;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableImageEffectBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm	2
CropImageEffect::buildConfigurationForm	public	function	Form constructor. Overrides ResizeImageEffect::buildConfigurationForm
CropImageEffect::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ResizeImageEffect::defaultConfiguration
CropImageEffect::submitConfigurationForm	public	function	Form submission handler. Overrides ResizeImageEffect::submitConfigurationForm
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		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
ScaleAndCropImageEffect::applyEffect	public	function	Applies an image effect to the image object. Overrides CropImageEffect::applyEffect
ScaleAndCropImageEffect::getSummary	public	function	Returns a render array summarizing the configuration of the image effect. Overrides CropImageEffect::getSummary
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.