class ImageToolkit

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/ImageToolkit/Annotation/ImageToolkit.php \Drupal\Core\ImageToolkit\Annotation\ImageToolkit
  2. 10 core/lib/Drupal/Core/ImageToolkit/Attribute/ImageToolkit.php \Drupal\Core\ImageToolkit\Attribute\ImageToolkit
  3. 10 core/lib/Drupal/Core/ImageToolkit/Annotation/ImageToolkit.php \Drupal\Core\ImageToolkit\Annotation\ImageToolkit
  4. 11.x core/lib/Drupal/Core/ImageToolkit/Attribute/ImageToolkit.php \Drupal\Core\ImageToolkit\Attribute\ImageToolkit
  5. 11.x core/lib/Drupal/Core/ImageToolkit/Annotation/ImageToolkit.php \Drupal\Core\ImageToolkit\Annotation\ImageToolkit

Defines a Plugin annotation object for the image toolkit plugin.

An image toolkit provides common image file manipulations like scaling, cropping, and rotating.

Plugin namespace: Plugin\ImageToolkit

For a working example, see \Drupal\system\Plugin\ImageToolkit\GDToolkit

Hierarchy

Expanded class hierarchy of ImageToolkit

See also

\Drupal\Core\ImageToolkit\Annotation\ImageToolkitOperation

\Drupal\Core\ImageToolkit\ImageToolkitInterface

\Drupal\Core\ImageToolkit\ImageToolkitBase

\Drupal\Core\ImageToolkit\ImageToolkitManager

Plugin API

Related topics

Annotations
Annotations for class discovery and metadata description.
4 classes are annotated with ImageToolkit
BrokenToolkit in core/modules/system/tests/modules/image_test/src/Plugin/ImageToolkit/BrokenToolkit.php
Defines a Test toolkit for image manipulation within Drupal.
DerivedToolkit in core/modules/system/tests/modules/image_test/src/Plugin/ImageToolkit/DerivedToolkit.php
Provides a derivative of TestToolkit.
GDToolkit in core/modules/system/src/Plugin/ImageToolkit/GDToolkit.php
Defines the GD2 toolkit for image manipulation within Drupal.
TestToolkit in core/modules/system/tests/modules/image_test/src/Plugin/ImageToolkit/TestToolkit.php
Defines a Test toolkit for image manipulation within Drupal.

File

core/lib/Drupal/Core/ImageToolkit/Annotation/ImageToolkit.php, line 26

Namespace

Drupal\Core\ImageToolkit\Annotation
View source 
class ImageToolkit extends Plugin {
    
    /**
     * The plugin ID.
     *
     * @var string
     */
    public $id;
    
    /**
     * The title of the image toolkit.
     *
     * The string should be wrapped in @Translation().
     *
     * @ingroup plugin_translatable
     *
     * @var \Drupal\Core\Annotation\Translation
     */
    public $title;

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
ImageToolkit::$id public property The plugin ID.
ImageToolkit::$title public property The title of the image toolkit.
Plugin::$definition protected property The plugin definition read from the class annotation. 1
Plugin::get public function Gets the value of an annotation. Overrides AnnotationInterface::get 6
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass 1
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 1
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass 1
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. 3

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.