You are here

Home » API reference » Focal Point 8 » FocalPointCropImageEffect.php

class FocalPointCropImageEffect in Focal Point 8

Crops image while keeping its focal point as close to centered as possible.

Plugin annotation


@ImageEffect(
  id = "focal_point_crop",
  label = @Translation("Focal Point Crop"),
  description = @Translation("Crops image while keeping its focal point as close to centered as possible.")
)

Hierarchy

Expanded class hierarchy of FocalPointCropImageEffect

2 files declare their use of FocalPointCropImageEffect
FocalPointEffectsTest.php in tests/src/Unit/Effects/FocalPointEffectsTest.php
FocalPointUnitTestCase.php in tests/src/Unit/FocalPointUnitTestCase.php

File

src/Plugin/ImageEffect/FocalPointCropImageEffect.php, line 17

Namespace

Drupal\focal_point\Plugin\ImageEffect
View source 
class FocalPointCropImageEffect extends FocalPointEffectBase {

  /**
   * {@inheritdoc}
   *
   * @codeCoverageIgnore
   */
  public function applyEffect(ImageInterface $image) {
    parent::applyEffect($image);
    $crop = $this
      ->getCrop($image);
    return $this
      ->applyCrop($image, $crop);
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {

    // Include a `crop_type` so that the crop module can act on images
    // generated using this effect.
    // @see crop_file_url_alter()
    // @see https://www.drupal.org/node/2929502
    return parent::defaultConfiguration() + [
      'crop_type' => 'focal_point',
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigurableImageEffectBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 2
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
FocalPointCropImageEffect::applyEffect public function @codeCoverageIgnore Overrides FocalPointEffectBase::applyEffect
FocalPointCropImageEffect::defaultConfiguration public function Gets default configuration for this plugin. Overrides ResizeImageEffect::defaultConfiguration
FocalPointEffectBase::$cropStorage protected property Crop storage.
FocalPointEffectBase::$focalPointConfig protected property Focal point configuration object.
FocalPointEffectBase::$focalPointManager protected property Focal point manager object.
FocalPointEffectBase::$originalImageSize protected property The original image dimensions before any effects are applied.
FocalPointEffectBase::$request public property The current request object.
FocalPointEffectBase::applyCrop public function Applies the crop effect to an image.
FocalPointEffectBase::calculateAnchor protected function Calculate the top left coordinates of crop rectangle.
FocalPointEffectBase::calculateResizeData public static function Calculate the resize dimensions of an image.
FocalPointEffectBase::constrainCropArea protected function Calculate the anchor such that the crop will not exceed the image boundary.
FocalPointEffectBase::create public static function @codeCoverageIgnore Overrides ImageEffectBase::create
FocalPointEffectBase::getAnchor public function Get the top-left anchor position of the crop area.
FocalPointEffectBase::getCrop public function Get the cropped image.
FocalPointEffectBase::getCropStorage public function Returns the crop storage.
FocalPointEffectBase::getFocalPointConfig public function Returns the focal point config.
FocalPointEffectBase::getOriginalFocalPoint protected function Returns the focal point value (in pixels) relative to the original image.
FocalPointEffectBase::getOriginalImageSize public function Return the original image dimensions.
FocalPointEffectBase::getPreviewValue protected function Get the 'focal_point_preview_value' query string value. 1
FocalPointEffectBase::setOriginalImageSize public function Set original image size.
FocalPointEffectBase::transformFocalPoint protected function Returns the focal point value (in pixels) relative to the provided image.
FocalPointEffectBase::__construct public function Constructs a \Drupal\focal_point\FocalPointEffectBase object. Overrides ImageEffectBase::__construct
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::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
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::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 2
ResizeImageEffect::getSummary public function Returns a render array summarizing the configuration of the image effect. Overrides ImageEffectBase::getSummary 2
ResizeImageEffect::submitConfigurationForm public function Form submission handler. Overrides ConfigurableImageEffectBase::submitConfigurationForm 2
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.