1. 8.2.x core/lib/Drupal/Core/ImageToolkit/Annotation/ImageToolkitOperation.php ImageToolkitOperation
  2. 8.0.x core/lib/Drupal/Core/ImageToolkit/Annotation/ImageToolkitOperation.php ImageToolkitOperation
  3. 8.1.x core/lib/Drupal/Core/ImageToolkit/Annotation/ImageToolkitOperation.php ImageToolkitOperation
  4. 8.3.x core/lib/Drupal/Core/ImageToolkit/Annotation/ImageToolkitOperation.php ImageToolkitOperation

Defines a Plugin annotation object for the image toolkit operation plugin.

An image toolkit operation plugin provides a self-contained image manipulation routine, for a specific image toolkit. Examples of image toolkit operations are scaling, cropping, rotating, etc.

Plugin namespace: Plugin\ImageToolkit\Operation

For a working example, see \Drupal\system\Plugin\ImageToolkit\Operation\gd\Crop

Hierarchy

Expanded class hierarchy of ImageToolkitOperation

See also

\Drupal\Core\ImageToolkit\Annotation\ImageToolkit

\Drupal\image\Annotation\ImageEffect

\Drupal\Core\ImageToolkit\ImageToolkitOperationInterface

\Drupal\Core\ImageToolkit\ImageToolkitOperationBase

\Drupal\Core\ImageToolkit\ImageToolkitOperationManager

Plugin API

Related topics

11 classes are annotated with ImageToolkitOperation
Bar in core/modules/system/tests/modules/image_test/src/Plugin/ImageToolkit/Operation/test/Bar.php
Builds an image toolkit operation.
Convert in core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Convert.php
Defines GD2 convert operation.
CreateNew in core/modules/system/src/Plugin/ImageToolkit/Operation/gd/CreateNew.php
Defines GD2 create_new image operation.
Crop in core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Crop.php
Defines GD2 Crop operation.
Desaturate in core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Desaturate.php
Defines GD2 Desaturate operation.

... See full list

File

core/lib/Drupal/Core/ImageToolkit/Annotation/ImageToolkitOperation.php, line 28

Namespace

Drupal\Core\ImageToolkit\Annotation
View source
class ImageToolkitOperation extends Plugin {

  /**
   * The plugin ID.
   *
   * There are no strict requirements as to the string to be used to identify
   * the plugin, since discovery of the appropriate operation plugin to be
   * used to apply an operation is based on the values of the 'toolkit' and
   * the 'operation' annotation values.
   *
   * However, it is recommended that the following patterns be used:
   * - '{toolkit}_{operation}' for the first implementation of an operation
   *   by a toolkit.
   * - '{module}_{toolkit}_{operation}' for overrides of existing
   *   implementations supplied by an alternative module, and for new
   *   module-supplied operations.
   *
   * @var string
   */
  public $id;

  /**
   * The id of the image toolkit plugin for which the operation is implemented.
   *
   * @var string
   */
  public $toolkit;

  /**
   * The machine name of the image toolkit operation implemented (e.g. "crop").
   *
   * @var string
   */
  public $operation;

  /**
   * The human-readable name of the image toolkit operation.
   *
   * The string should be wrapped in a @Translation().
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $label;

  /**
   * The description of the image toolkit operation.
   *
   * The string should be wrapped in a @Translation().
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $description;

}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
ImageToolkitOperation::$description public property The description of the image toolkit operation.
ImageToolkitOperation::$id public property The plugin ID.
ImageToolkitOperation::$label public property The human-readable name of the image toolkit operation.
ImageToolkitOperation::$operation public property The machine name of the image toolkit operation implemented (e.g. "crop").
ImageToolkitOperation::$toolkit public property The id of the image toolkit plugin for which the operation is implemented.
Plugin::$definition protected property The plugin definition read from the class annotation.
Plugin::get public function Gets the value of an annotation. Overrides AnnotationInterface::get
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId public function Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider public function Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider public function Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct public function Constructs a Plugin object.