class ScaleAndCropImageEffect

Same name in other branches
  1. 8.9.x core/modules/image/src/Plugin/ImageEffect/ScaleAndCropImageEffect.php \Drupal\image\Plugin\ImageEffect\ScaleAndCropImageEffect
  2. 10 core/modules/image/src/Plugin/ImageEffect/ScaleAndCropImageEffect.php \Drupal\image\Plugin\ImageEffect\ScaleAndCropImageEffect
  3. 11.x core/modules/image/src/Plugin/ImageEffect/ScaleAndCropImageEffect.php \Drupal\image\Plugin\ImageEffect\ScaleAndCropImageEffect

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

Expanded class hierarchy of ScaleAndCropImageEffect

File

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

Namespace

Drupal\image\Plugin\ImageEffect
View source 
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());
        [
            $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

Title Modifiers Object type Summary Overriden Title Overrides
ConfigurableImageEffectBase::validateConfigurationForm public function 2
CropImageEffect::buildConfigurationForm public function Overrides ResizeImageEffect::buildConfigurationForm
CropImageEffect::defaultConfiguration public function Gets default configuration for this plugin. Overrides ResizeImageEffect::defaultConfiguration
CropImageEffect::submitConfigurationForm public function Overrides ResizeImageEffect::submitConfigurationForm
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
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
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

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.