You are here

class AutoOrient in Image Effects 8

Same name in this branch
  1. 8 src/Plugin/ImageToolkit/Operation/gd/AutoOrient.php \Drupal\image_effects\Plugin\ImageToolkit\Operation\gd\AutoOrient
  2. 8 src/Plugin/ImageToolkit/Operation/imagemagick/AutoOrient.php \Drupal\image_effects\Plugin\ImageToolkit\Operation\imagemagick\AutoOrient
Same name and namespace in other branches
  1. 8.3 src/Plugin/ImageToolkit/Operation/gd/AutoOrient.php \Drupal\image_effects\Plugin\ImageToolkit\Operation\gd\AutoOrient
  2. 8.2 src/Plugin/ImageToolkit/Operation/gd/AutoOrient.php \Drupal\image_effects\Plugin\ImageToolkit\Operation\gd\AutoOrient

Defines GD AutoOrient operation.

Plugin annotation


@ImageToolkitOperation(
  id = "image_effects_gd_auto_orient",
  toolkit = "gd",
  operation = "auto_orient",
  label = @Translation("Auto orient image"),
  description = @Translation("Automatically adjusts the orientation of an image.")
)

Hierarchy

Expanded class hierarchy of AutoOrient

File

src/Plugin/ImageToolkit/Operation/gd/AutoOrient.php, line 18

Namespace

Drupal\image_effects\Plugin\ImageToolkit\Operation\gd
View source
class AutoOrient extends GDImageToolkitOperationBase {

  /**
   * {@inheritdoc}
   */
  protected function arguments() {

    // This operation does not use any parameters.
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function execute(array $arguments) {

    // If image has been created in memory, this will not apply.
    if (!($source_path = $this
      ->getToolkit()
      ->getSource())) {
      return TRUE;
    }

    // Will not work without EXIF extension installed.
    if (!function_exists('exif_read_data')) {
      $this->logger
        ->notice('The image %file could not be auto-rotated because the exif_read_data() function is not available in this PHP installation. Check if the PHP EXIF extension is enabled.', [
        '%file' => $this
          ->getToolkit()
          ->getSource(),
      ]);
      return FALSE;
    }

    // Read EXIF data.
    $exif = @exif_read_data(\Drupal::service('file_system')
      ->realpath($source_path));
    if (isset($exif['Orientation'])) {

      // http://www.sno.phy.queensu.ca/~phil/exiftool/TagNames/EXIF.html:
      // 1 = Horizontal (normal)                 [top-left].
      // 2 = Mirror horizontal                   [top-right].
      // 3 = Rotate 180                          [bottom-right].
      // 4 = Mirror vertical                     [bottom-left].
      // 5 = Mirror horizontal and rotate 270 CW [left-top].
      // 6 = Rotate 90 CW                        [right-top].
      // 7 = Mirror horizontal and rotate 90 CW  [right-bottom].
      // 8 = Rotate 270 CW                       [left-bottom].
      switch ($exif['Orientation']) {
        case 2:
          return $this
            ->getToolkit()
            ->apply('mirror', [
            'x_axis' => TRUE,
          ]);
        case 3:
          return $this
            ->getToolkit()
            ->apply('rotate', [
            'degrees' => 180,
          ]);
        case 4:
          return $this
            ->getToolkit()
            ->apply('mirror', [
            'y_axis' => TRUE,
          ]);
        case 5:
          $tmp = $this
            ->getToolkit()
            ->apply('mirror', [
            'x_axis' => TRUE,
          ]);
          if ($tmp) {
            $tmp = $this
              ->getToolkit()
              ->apply('rotate', [
              'degrees' => 270,
            ]);
          }
          return $tmp;
        case 6:
          return $this
            ->getToolkit()
            ->apply('rotate', [
            'degrees' => 90,
          ]);
        case 7:
          $tmp = $this
            ->getToolkit()
            ->apply('mirror', [
            'x_axis' => TRUE,
          ]);
          if ($tmp) {
            $tmp = $this
              ->getToolkit()
              ->apply('rotate', [
              'degrees' => 90,
            ]);
          }
          return $tmp;
        case 8:
          return $this
            ->getToolkit()
            ->apply('rotate', [
            'degrees' => 270,
          ]);
        default:
          return TRUE;
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AutoOrient::arguments protected function Returns the definition of the operation arguments. Overrides ImageToolkitOperationBase::arguments
AutoOrient::execute protected function Performs the actual manipulation on the image. Overrides ImageToolkitOperationBase::execute
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
GDImageToolkitOperationBase::getToolkit protected function The correctly typed image toolkit for GD operations. Overrides ImageToolkitOperationBase::getToolkit
ImageToolkitOperationBase::$logger protected property A logger instance.
ImageToolkitOperationBase::$toolkit protected property The image toolkit.
ImageToolkitOperationBase::apply final public function Applies a toolkit specific operation to an image. Overrides ImageToolkitOperationInterface::apply
ImageToolkitOperationBase::prepareArguments protected function Checks if required arguments are passed in and adds defaults for non passed in optional arguments.
ImageToolkitOperationBase::validateArguments protected function Validates the arguments. 6
ImageToolkitOperationBase::__construct public function Constructs an image toolkit operation plugin. 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.
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.