class ScaleImageEffect
Scales an image resource.
Attributes
#[ImageEffect(id: "image_scale", label: new TranslatableMarkup("Scale"), description: new TranslatableMarkup("Scaling will maintain the aspect-ratio of the original image. If only a single dimension is specified, the other dimension will be calculated."))]
  Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \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 extends \Drupal\Component\Plugin\PluginBase- class \Drupal\image\ImageEffectBase implements \Drupal\image\ImageEffectInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface extends \Drupal\Core\Plugin\PluginBase- class \Drupal\image\ConfigurableImageEffectBase implements \Drupal\image\ConfigurableImageEffectInterface extends \Drupal\image\ImageEffectBase- class \Drupal\image\Plugin\ImageEffect\ResizeImageEffect extends \Drupal\image\ConfigurableImageEffectBase- class \Drupal\image\Plugin\ImageEffect\ScaleImageEffect extends \Drupal\image\Plugin\ImageEffect\ResizeImageEffect
 
 
- class \Drupal\image\Plugin\ImageEffect\ResizeImageEffect extends \Drupal\image\ConfigurableImageEffectBase
 
- class \Drupal\image\ConfigurableImageEffectBase implements \Drupal\image\ConfigurableImageEffectInterface extends \Drupal\image\ImageEffectBase
 
- class \Drupal\image\ImageEffectBase implements \Drupal\image\ImageEffectInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface extends \Drupal\Core\Plugin\PluginBase
 
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of ScaleImageEffect
File
- 
              core/modules/ image/ src/ Plugin/ ImageEffect/ ScaleImageEffect.php, line 14 
Namespace
Drupal\image\Plugin\ImageEffectView 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 | 
|---|---|---|---|---|---|
| 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. | 25 | |
| MessengerTrait::messenger | public | function | Gets the messenger. | 25 | |
| 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. | ||
| ScaleImageEffect::applyEffect | public | function | Applies an image effect to the image object. | Overrides ResizeImageEffect::applyEffect | |
| ScaleImageEffect::buildConfigurationForm | public | function | Form constructor. | 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 | Form submission handler. | Overrides ResizeImageEffect::submitConfigurationForm | |
| ScaleImageEffect::transformDimensions | public | function | Determines the dimensions of the styled image. | Overrides ResizeImageEffect::transformDimensions | |
| ScaleImageEffect::validateConfigurationForm | public | function | Form validation handler. | Overrides ConfigurableImageEffectBase::validateConfigurationForm | |
| 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.
