You are here

Home » API reference » Image Effects 8.3 » SmartCropImageEffect.php

class SmartCropImageEffect in Image Effects 8.3

Same name and namespace in other branches
  1. 8 src/Plugin/ImageEffect/SmartCropImageEffect.php \Drupal\image_effects\Plugin\ImageEffect\SmartCropImageEffect
  2. 8.2 src/Plugin/ImageEffect/SmartCropImageEffect.php \Drupal\image_effects\Plugin\ImageEffect\SmartCropImageEffect

Crop an image preserving the portion with the most entropy.

Plugin annotation


@ImageEffect(
  id = "image_effects_smart_crop",
  label = @Translation("Smart Crop"),
  description = @Translation("Similar to Crop, but preserves the portion of the image with the most entropy.")
)

Hierarchy

Expanded class hierarchy of SmartCropImageEffect

File

src/Plugin/ImageEffect/SmartCropImageEffect.php, line 19

Namespace

Drupal\image_effects\Plugin\ImageEffect
View source 
class SmartCropImageEffect extends ConfigurableImageEffectBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'width' => NULL,
      'height' => NULL,
      'square' => FALSE,
      'simulate' => FALSE,
      'algorithm' => 'entropy_slice',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getSummary() {
    return [
      '#theme' => 'image_effects_smart_crop_summary',
      '#data' => $this->configuration,
    ] + parent::getSummary();
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['width'] = [
      '#type' => 'image_effects_px_perc',
      '#title' => $this
        ->t('Width'),
      '#default_value' => $this->configuration['width'],
      '#description' => $this
        ->t('Enter a value, and specify if pixels or percent. Leave blank to scale according to new height.'),
      '#size' => 5,
      '#maxlength' => 5,
      '#required' => FALSE,
    ];
    $form['height'] = [
      '#type' => 'image_effects_px_perc',
      '#title' => $this
        ->t('Height'),
      '#default_value' => $this->configuration['height'],
      '#description' => $this
        ->t('Enter a value, and specify if pixels or percent. Leave blank to scale according to new width.'),
      '#size' => 5,
      '#maxlength' => 5,
      '#required' => FALSE,
    ];
    $form['square'] = [
      '#type' => 'checkbox',
      '#default_value' => $this->configuration['square'],
      '#title' => $this
        ->t('Square'),
      '#description' => $this
        ->t('Forces the crop to be a square. Applies if only one crop dimension is set, and specified as % of the source image.'),
      '#states' => [
        'visible' => [
          [
            ':radio[name="data[width][c0][c1][uom]"]' => [
              'value' => 'perc',
            ],
          ],
          [
            ':radio[name="data[height][c0][c1][uom]"]' => [
              'value' => 'perc',
            ],
          ],
        ],
      ],
    ];
    $form['advanced'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Advanced settings'),
    ];
    $form['advanced']['algorithm'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Calculation algorithm'),
      '#options' => [
        'entropy_slice' => $this
          ->t('Image entropy - slicing'),
        'entropy_grid' => $this
          ->t('Image entropy - recursive grid'),
      ],
      '#description' => $this
        ->t('Select an algorithm to use to determine the crop area.'),
      '#default_value' => $this->configuration['algorithm'],
    ];
    $form['advanced']['simulate'] = [
      '#type' => 'checkbox',
      '#default_value' => $this->configuration['simulate'],
      '#title' => $this
        ->t('Simulate'),
      '#description' => $this
        ->t('If selected, the crop will not be executed; the crop area will be highlighted on the source image instead.'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::validateConfigurationForm($form, $form_state);
    $width = $form_state
      ->getValue('width');
    $height = $form_state
      ->getValue('height');
    if ((bool) $width === FALSE && (bool) $height === FALSE) {
      $form_state
        ->setError($form, $this
        ->t("Either <em>Width</em> or <em>Height</em> must be specified."));
    }
    if (strpos($width, '%') !== FALSE && (int) str_replace('%', '', $width) > 100) {
      $form_state
        ->setErrorByName('width', $this
        ->t("A percentage crop can not be wider than the source image."));
    }
    if (strpos($height, '%') !== FALSE && (int) str_replace('%', '', $height) > 100) {
      $form_state
        ->setErrorByName('height', $this
        ->t("A percentage crop can not be higher than the source image."));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $width = $form_state
      ->getValue('width');
    $height = $form_state
      ->getValue('height');
    $this->configuration['width'] = $width;
    $this->configuration['height'] = $height;
    if (strpos($width, '%') !== FALSE || strpos($height, '%') !== FALSE) {
      $this->configuration['square'] = $form_state
        ->getValue('square');
    }
    else {
      $this->configuration['square'] = FALSE;
    }
    $this->configuration['algorithm'] = $form_state
      ->getValue([
      'advanced',
      'algorithm',
    ]);
    $this->configuration['simulate'] = $form_state
      ->getValue([
      'advanced',
      'simulate',
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function transformDimensions(array &$dimensions, $uri) {
    if (!$dimensions['width'] || !$dimensions['height']) {
      return;
    }
    if ($this->configuration['simulate']) {
      return;
    }
    $d = ImageUtility::resizeDimensions($dimensions['width'], $dimensions['height'], $this->configuration['width'], $this->configuration['height'], $this->configuration['square']);

    // Ensure crop dimensions fit in the source image.
    $dimensions['width'] = min($dimensions['width'], $d['width']);
    $dimensions['height'] = min($dimensions['height'], $d['height']);
  }

  /**
   * {@inheritdoc}
   */
  public function applyEffect(ImageInterface $image) {
    $dimensions = ImageUtility::resizeDimensions($image
      ->getWidth(), $image
      ->getHeight(), $this->configuration['width'], $this->configuration['height'], $this->configuration['square']);
    return $image
      ->apply('smart_crop', [
      'width' => min($dimensions['width'], $image
        ->getWidth()),
      'height' => min($dimensions['height'], $image
        ->getHeight()),
      'algorithm' => $this->configuration['algorithm'],
      'simulate' => $this->configuration['simulate'],
    ]);
  }

}

Members

Namesort descending Modifiers Type Description 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 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
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.
SmartCropImageEffect::applyEffect public function Applies an image effect to the image object. Overrides ImageEffectInterface::applyEffect
SmartCropImageEffect::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
SmartCropImageEffect::defaultConfiguration public function Gets default configuration for this plugin. Overrides ImageEffectBase::defaultConfiguration
SmartCropImageEffect::getSummary public function Returns a render array summarizing the configuration of the image effect. Overrides ImageEffectBase::getSummary
SmartCropImageEffect::submitConfigurationForm public function Form submission handler. Overrides ConfigurableImageEffectBase::submitConfigurationForm
SmartCropImageEffect::transformDimensions public function Determines the dimensions of the styled image. Overrides ImageEffectBase::transformDimensions
SmartCropImageEffect::validateConfigurationForm public function Form validation handler. Overrides ConfigurableImageEffectBase::validateConfigurationForm
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.