class ScaleImageEffect

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

Scales an image resource.

Plugin annotation


@ImageEffect(
  id = "image_scale",
  label = @Translation("Scale"),
  description = @Translation("Scaling will maintain the aspect-ratio of the original image. If only a single dimension is specified, the other dimension will be calculated.")
)

Hierarchy

Expanded class hierarchy of ScaleImageEffect

File

core/modules/image/src/Plugin/ImageEffect/ScaleImageEffect.php, line 18

Namespace

Drupal\image\Plugin\ImageEffect
View source
class ScaleImageEffect extends ResizeImageEffect {
    
    /**
     * {@inheritdoc}
     */
    public function applyEffect(ImageInterface $image) {
        if (!$image->scale($this->configuration['width'], $this->configuration['height'], $this->configuration['upscale'])) {
            $this->logger
                ->error('Image scale 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 transformDimensions(array &$dimensions, $uri) {
        if ($dimensions['width'] && $dimensions['height']) {
            Image::scaleDimensions($dimensions, $this->configuration['width'], $this->configuration['height'], $this->configuration['upscale']);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function getSummary() {
        $summary = [
            '#theme' => 'image_scale_summary',
            '#data' => $this->configuration,
        ];
        $summary += parent::getSummary();
        return $summary;
    }
    
    /**
     * {@inheritdoc}
     */
    public function defaultConfiguration() {
        return parent::defaultConfiguration() + [
            'upscale' => FALSE,
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
        $form = parent::buildConfigurationForm($form, $form_state);
        $form['width']['#required'] = FALSE;
        $form['height']['#required'] = FALSE;
        $form['upscale'] = [
            '#type' => 'checkbox',
            '#default_value' => $this->configuration['upscale'],
            '#title' => $this->t('Allow Upscaling'),
            '#description' => $this->t('Let scale make images larger than their original size.'),
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
        parent::validateConfigurationForm($form, $form_state);
        if ($form_state->isValueEmpty('width') && $form_state->isValueEmpty('height')) {
            $form_state->setErrorByName('data', $this->t('Width and height can not both be blank.'));
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
        parent::submitConfigurationForm($form, $form_state);
        $this->configuration['upscale'] = $form_state->getValue('upscale');
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
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
ScaleImageEffect::applyEffect public function Applies an image effect to the image object. Overrides ResizeImageEffect::applyEffect
ScaleImageEffect::buildConfigurationForm public function Overrides ResizeImageEffect::buildConfigurationForm
ScaleImageEffect::defaultConfiguration public function Gets default configuration for this plugin. Overrides ResizeImageEffect::defaultConfiguration
ScaleImageEffect::getSummary public function Returns a render array summarizing the configuration of the image effect. Overrides ResizeImageEffect::getSummary
ScaleImageEffect::submitConfigurationForm public function Overrides ResizeImageEffect::submitConfigurationForm
ScaleImageEffect::transformDimensions public function Determines the dimensions of the styled image. Overrides ResizeImageEffect::transformDimensions
ScaleImageEffect::validateConfigurationForm public function Overrides ConfigurableImageEffectBase::validateConfigurationForm

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