You are here

class ImagemagickExecutionEvent in ImageMagick 8.3

Same name and namespace in other branches
  1. 8.2 src/Event/ImagemagickExecutionEvent.php \Drupal\imagemagick\Event\ImagemagickExecutionEvent

Defines the ImagemagickExecutionEvent.

Hierarchy

Expanded class hierarchy of ImagemagickExecutionEvent

3 files declare their use of ImagemagickExecutionEvent
ImagemagickEventSubscriber.php in src/EventSubscriber/ImagemagickEventSubscriber.php
ImagemagickIdentify.php in src/Plugin/FileMetadata/ImagemagickIdentify.php
ImagemagickToolkit.php in src/Plugin/ImageToolkit/ImagemagickToolkit.php

File

src/Event/ImagemagickExecutionEvent.php, line 11

Namespace

Drupal\imagemagick\Event
View source
class ImagemagickExecutionEvent extends Event {

  /**
   * Fires when the toolkit is ensuring a local file path for the source image.
   *
   * @Event
   *
   * @see \Drupal\imagemagick\Plugin\ImageToolkit\ImagemagickToolkit::ensureSourceLocalPath()
   *
   * @var string
   */
  const ENSURE_SOURCE_LOCAL_PATH = 'imagemagick.toolkit.ensureSourceLocalPath';

  /**
   * Fires after an image has been saved by the ImageMagick toolkit.
   *
   * @Event
   *
   * @see \Drupal\imagemagick\Plugin\ImageToolkit\ImagemagickToolkit::save()
   *
   * @var string
   */
  const POST_SAVE = 'imagemagick.toolkit.postSave';

  /**
   * Fires before the 'convert' command is executed.
   *
   * @Event
   *
   * @see \Drupal\imagemagick\Plugin\ImageToolkit\ImagemagickToolkit::convert()
   *
   * @var string
   */
  const PRE_CONVERT_EXECUTE = 'imagemagick.convert.preExecute';

  /**
   * Fires before the 'identify' command is executed.
   *
   * @Event
   *
   * @see \Drupal\imagemagick\Plugin\FileMetadata\ImagemagickIdentify::identify()
   *
   * @var string
   */
  const PRE_IDENTIFY_EXECUTE = 'imagemagick.identify.preExecute';

  /**
   * The ImageMagick/GraphicsMagick execution arguments object.
   *
   * @var \Drupal\imagemagick\ImagemagickExecArguments
   */
  protected $arguments;

  /**
   * Constructs the object.
   *
   * @param \Drupal\imagemagick\ImagemagickExecArguments $arguments
   *   The ImageMagick/GraphicsMagick execution arguments object.
   */
  public function __construct(ImagemagickExecArguments $arguments) {
    $this->arguments = $arguments;
  }

  /**
   * Returns the ImagemagickExecArguments object.
   *
   * @return \Drupal\imagemagick\ImagemagickExecArguments
   *   The ImageMagick/GraphicsMagick execution arguments object.
   */
  public function getExecArguments() : ImagemagickExecArguments {
    return $this->arguments;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ImagemagickExecutionEvent::$arguments protected property The ImageMagick/GraphicsMagick execution arguments object.
ImagemagickExecutionEvent::ENSURE_SOURCE_LOCAL_PATH constant Fires when the toolkit is ensuring a local file path for the source image.
ImagemagickExecutionEvent::getExecArguments public function Returns the ImagemagickExecArguments object.
ImagemagickExecutionEvent::POST_SAVE constant Fires after an image has been saved by the ImageMagick toolkit.
ImagemagickExecutionEvent::PRE_CONVERT_EXECUTE constant Fires before the 'convert' command is executed.
ImagemagickExecutionEvent::PRE_IDENTIFY_EXECUTE constant Fires before the 'identify' command is executed.
ImagemagickExecutionEvent::__construct public function Constructs the object.