You are here

Home » API reference » Image Focus Crop 8 » FocusScaleCropImageEffect.php

class FocusScaleCropImageEffect in Image Focus Crop 8

Crops with focus an image resource.

Plugin annotation


@ImageEffect(
  id = "image_focus_scale_crop",
  label = @Translation("Focus Scale and Crop"),
  description = @Translation("Use Image entrophy to detect focal point")
)

Hierarchy

Expanded class hierarchy of FocusScaleCropImageEffect

File

src/Plugin/ImageEffect/FocusScaleCropImageEffect.php, line 20

Namespace

Drupal\image_focus\Plugin\ImageEffect
View source 
class FocusScaleCropImageEffect extends ResizeImageEffect {

  /**
   * {@inheritdoc}
   */
  public function applyEffect(ImageInterface $image) {
    $width = $this->configuration['width'];
    $height = $this->configuration['height'];
    list($cx, $cy) = $this
      ->getFocalPoint($image);
    $scale = max($width / $image
      ->getWidth(), $height / $image
      ->getHeight());
    if (!$image
      ->resize($image
      ->getWidth() * $scale, $image
      ->getHeight() * $scale)) {
      $this->logger
        ->error('Image resize 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;
    }
    $x = max(0, min($image
      ->getWidth() - $width, $cx * $scale - $width / 2));
    $y = max(0, min($image
      ->getHeight() - $height, $cy * $scale - $height / 2));
    if (!$image
      ->crop($x, $y, $width, $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;
  }

  /**
   * Method getFocalPoint.
   *
   * @param \Drupal\Core\Image\ImageInterface $image
   *   Image.
   *
   * @return array
   *   Return array.
   */
  private function getFocalPoint(ImageInterface $image) {
    $extension = str_replace('jpg', 'jpeg', explode('/', $image
      ->getMimeType())[1]);
    $function = 'imagecreatefrom' . $extension;
    if (function_exists($function) && ($resource = $function($image
      ->getSource()))) {
      if ($this->configuration['face_detect']) {
        $config = \Drupal::configFactory()
          ->get('image_focus.settings');
        if ($config
          ->get('image_focus_face_detection_maxsize') * 1024 > $image
          ->getFileSize() && ($result = $this
          ->getFaceDetection($resource))) {
          return $result;
        }
      }
      if ($result = $this
        ->getImageEntropy($resource)) {
        return $result;
      }
    }
    return [
      $image
        ->getWidth() / 2,
      $image
        ->getHeight() / 2,
    ];
  }

  /**
   * Method getImageEntropy.
   *
   * @param mixed $resource
   *   Resource.
   *
   * @return array
   *   Return array.
   */
  private function getImageEntropy($resource) {
    $entropy = new ImageFocusEntropy($resource);
    return $entropy
      ->getFocalPoint();
  }

  /**
   * Get Face detection.
   *
   * @param mixed $resource
   *   Resource.
   *
   * @return array|bool
   *   Points of false.
   */
  private function getFaceDetection($resource) {
    $detector = new FaceDetector();
    $detector
      ->faceDetect($resource);
    if ($face = $detector
      ->getFace()) {
      return [
        $face['x'] + $face['w'] / 2,
        $face['y'] + $face['w'] / 2,
      ];
    }
    return FALSE;
  }

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

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return parent::defaultConfiguration() + [
      'face_detect' => FALSE,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $form['face_detect'] = [
      '#type' => 'checkbox',
      '#title' => t('Face detect'),
      '#default_value' => $this->configuration['face_detect'],
      '#description' => t('Enable face detect to get focal point.'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this->configuration['face_detect'] = $form_state
      ->getValue('face_detect');
  }

}

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
FocusScaleCropImageEffect::applyEffect public function Applies an image effect to the image object. Overrides ResizeImageEffect::applyEffect
FocusScaleCropImageEffect::buildConfigurationForm public function Form constructor. Overrides ResizeImageEffect::buildConfigurationForm
FocusScaleCropImageEffect::defaultConfiguration public function Gets default configuration for this plugin. Overrides ResizeImageEffect::defaultConfiguration
FocusScaleCropImageEffect::getFaceDetection private function Get Face detection.
FocusScaleCropImageEffect::getFocalPoint private function Method getFocalPoint.
FocusScaleCropImageEffect::getImageEntropy private function Method getImageEntropy.
FocusScaleCropImageEffect::getSummary public function Returns a render array summarizing the configuration of the image effect. Overrides ResizeImageEffect::getSummary
FocusScaleCropImageEffect::submitConfigurationForm public function Form submission handler. Overrides ResizeImageEffect::submitConfigurationForm
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.
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.