class RelativeCropImageEffect in Image Effects 8.3

Provides an image effect that crops images to a ratio.

Plugin annotation


@ImageEffect(
  id = "image_effects_relative_crop",
  label = @Translation("Relative crop"),
  description = @Translation("Resizing will make images match a ratio, for example 4:3 or 16:9. Images that are wider than the ratio will be cropped in width, images that are higher than the ratio will be cropped in height."),
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\image\ImageEffectBase implements ContainerFactoryPluginInterface, ImageEffectInterface
    class \Drupal\image\ConfigurableImageEffectBase implements ConfigurableImageEffectInterface
    class \Drupal\image\Plugin\ImageEffect\ResizeImageEffect
    class \Drupal\image\Plugin\ImageEffect\CropImageEffect
    class \Drupal\image_effects\Plugin\ImageEffect\RelativeCropImageEffect

Expanded class hierarchy of RelativeCropImageEffect

File

src/Plugin/ImageEffect/RelativeCropImageEffect.php, line 18

Namespace

Drupal\image_effects\Plugin\ImageEffect

View source

class RelativeCropImageEffect extends CropImageEffect {

  /**
   * {@inheritdoc}
   */
  public function applyEffect(ImageInterface $image) {
    $dimensions = [
      'width' => $image
        ->getWidth(),
      'height' => $image
        ->getHeight(),
    ];

    // Bail if the image is invalid.
    if ($dimensions['width'] === NULL || $dimensions['height'] === NULL) {
      return FALSE;
    }
    $original_dimensions = $dimensions;
    $this
      ->transformDimensions($dimensions, $image
      ->getSource());

    // Pick the right anchor depending on whether the image is being cropped in
    // width or in height.
    if ($dimensions['width'] !== $original_dimensions['width']) {
      $x = image_filter_keyword($this->configuration['anchor']['width'], $original_dimensions['width'], $dimensions['width']);
      $y = 0;
    }
    elseif ($dimensions['height'] !== $original_dimensions['height']) {
      $x = 0;
      $y = image_filter_keyword($this->configuration['anchor']['height'], $original_dimensions['height'], $dimensions['height']);
    }
    else {

      // If the image already has the correct dimensions, do not do anything.
      return TRUE;
    }
    if (!$image
      ->crop($x, $y, $dimensions['width'], $dimensions['height'])) {
      $this->logger
        ->error('Image 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 transformDimensions(array &$dimensions, $uri) {
    if (!$this->configuration['width'] || !$this->configuration['height']) {

      // If the effect has not been configured, there is nothing we can do.
      return;
    }
    $ratio = $this->configuration['width'] / $this->configuration['height'];

    // Figure out whether the image is too wide or too high.
    $ratio_width = (int) round($dimensions['height'] * $ratio);
    if ($dimensions['width'] > $ratio_width) {
      $dimensions['width'] = $ratio_width;
    }
    elseif ($dimensions['width'] < $ratio_width) {

      // Instead of it being too narrow we consider the image as being too tall.
      $dimensions['height'] = (int) round($dimensions['width'] / $ratio);
    }

    // If the image already fits the ratio, do not change the dimensions.
  }

  /**
   * {@inheritdoc}
   */
  public function getSummary() {
    return [
      '#theme' => 'image_effects_relative_crop_summary',
    ] + parent::getSummary();
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'anchor' => [
        'width' => 'center',
        'height' => 'center',
      ],
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['#tree'] = TRUE;
    $form = parent::buildConfigurationForm($form, $form_state);
    unset($form['width']['#field_suffix']);
    unset($form['height']['#field_suffix']);
    $form['anchor'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Anchor'),
    ];
    $form['anchor']['width'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Width'),
      '#options' => [
        'left' => $this
          ->t('Left'),
        'center' => $this
          ->t('Center'),
        'right' => $this
          ->t('Right'),
      ],
      '#default_value' => $this->configuration['anchor']['width'],
      '#description' => $this
        ->t('The anchor that will be used to crop images that are wider than the configured ratio.'),
    ];
    $form['anchor']['height'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Height'),
      '#options' => [
        'top' => $this
          ->t('Top'),
        'center' => $this
          ->t('Center'),
        'bottom' => $this
          ->t('Bottom'),
      ],
      '#default_value' => $this->configuration['anchor']['height'],
      '#description' => $this
        ->t('The anchor that will be used to crop images that are higher than the configured ratio.'),
    ];
    return $form;
  }

}

Members

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

You are here

class RelativeCropImageEffect in Image Effects 8.3

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation