public function ResizeImageEffect::transformDimensions in Drupal 9

Same name and namespace in other branches

8 core/modules/image/src/Plugin/ImageEffect/ResizeImageEffect.php \Drupal\image\Plugin\ImageEffect\ResizeImageEffect::transformDimensions()

Determines the dimensions of the styled image.

Parameters

array &$dimensions: Dimensions to be modified - an array with the following keys:

width: the width in pixels, or NULL if unknown
height: the height in pixels, or NULL if unknown

When either of the dimensions are NULL, the corresponding HTML attribute will be omitted when an image style using this image effect is used.

string $uri: Original image file URI. It is passed in to allow an effect to optionally use this information to retrieve additional image metadata to determine dimensions of the styled image. ImageEffectInterface::transformDimensions key objective is to calculate styled image dimensions without performing actual image operations, so be aware that performing IO on the URI may lead to decrease in performance.

Overrides ImageEffectBase::transformDimensions

1 method overrides ResizeImageEffect::transformDimensions()

ScaleImageEffect::transformDimensions in core/modules/image/src/Plugin/ImageEffect/ScaleImageEffect.php: Determines the dimensions of the styled image.

File

core/modules/image/src/Plugin/ImageEffect/ResizeImageEffect.php, line 34

Class

ResizeImageEffect: Resizes an image resource.

Namespace

Drupal\image\Plugin\ImageEffect

Code

public function transformDimensions(array &$dimensions, $uri) {

  // The new image will have the exact dimensions defined for the effect.
  $dimensions['width'] = $this->configuration['width'];
  $dimensions['height'] = $this->configuration['height'];
}

You are here