You are here

Home » API reference » Image max size crop 8 » MaxSizeCropImageEffect.php

class MaxSizeCropImageEffect in Image max size crop 8

Crop image with maximum sizes.

Crop an image resource with respect for maximum size, and with only one dimension required.

Plugin annotation


@ImageEffect(
  id = "image_max_size_crop",
  label = @Translation("Maximum size crop"),
  description = @Translation("Cropping will remove portions of an image to make it the specified dimensions. This style only resizes when the image dimension(s) is larger than the spedified dimension(s).")
)

Hierarchy

Expanded class hierarchy of MaxSizeCropImageEffect

File

src/Plugin/ImageEffect/MaxSizeCropImageEffect.php, line 21

Namespace

Drupal\image_max_size_crop\Plugin\ImageEffect
View source 
class MaxSizeCropImageEffect extends CropImageEffect {

  /**
   * {@inheritdoc}
   */
  public function applyEffect(ImageInterface $image) {

    // Set the desired dimensions, if the width is empty or not high enough.
    $original_width = $this->configuration['width'];
    if (!$this->configuration['width'] || $this->configuration['width'] > $image
      ->getWidth()) {
      $this->configuration['width'] = $image
        ->getWidth();
    }

    // Set the desired dimensions, if the height is empty or not high enough.
    $original_height = $this->configuration['height'];
    if (!$this->configuration['height'] || $this->configuration['height'] > $image
      ->getHeight()) {
      $this->configuration['height'] = $image
        ->getHeight();
    }
    $result = parent::applyEffect($image);

    // Restore configuration so that settings screen is shown correctly.
    $this->configuration['width'] = $original_width;
    $this->configuration['height'] = $original_height;
    return $result;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    unset($form['width']['#required']);
    unset($form['height']['#required']);
    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.'));
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CropImageEffect::defaultConfiguration public function Gets default configuration for this plugin. Overrides ResizeImageEffect::defaultConfiguration
CropImageEffect::getSummary public function Returns a render array summarizing the configuration of the image effect. Overrides ResizeImageEffect::getSummary 1
CropImageEffect::submitConfigurationForm public function Form submission handler. Overrides ResizeImageEffect::submitConfigurationForm
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 1
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
MaxSizeCropImageEffect::applyEffect public function Applies an image effect to the image object. Overrides CropImageEffect::applyEffect
MaxSizeCropImageEffect::buildConfigurationForm public function Form constructor. Overrides CropImageEffect::buildConfigurationForm
MaxSizeCropImageEffect::validateConfigurationForm public function Form validation handler. Overrides ConfigurableImageEffectBase::validateConfigurationForm
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
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 3
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
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
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.