class ImageToolkitOperation in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/lib/Drupal/Core/ImageToolkit/Annotation/ImageToolkitOperation.php \Drupal\Core\ImageToolkit\Annotation\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
- class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
- class \Drupal\Core\ImageToolkit\Annotation\ImageToolkitOperation
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
Related topics
8 classes are annotated with ImageToolkitOperation
- 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.
- Resize in core/
modules/ system/ src/ Plugin/ ImageToolkit/ Operation/ gd/ Resize.php - Defines GD2 resize operation.
File
- core/
lib/ Drupal/ Core/ ImageToolkit/ Annotation/ ImageToolkitOperation.php, line 33 - Contains \Drupal\Core\ImageToolkit\Annotation\ImageToolkitOperation.
Namespace
Drupal\Core\ImageToolkit\AnnotationView 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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ImageToolkitOperation:: |
public | property | The description of the image toolkit operation. | |
ImageToolkitOperation:: |
public | property | The plugin ID. | |
ImageToolkitOperation:: |
public | property | The human-readable name of the image toolkit operation. | |
ImageToolkitOperation:: |
public | property | The machine name of the image toolkit operation implemented (e.g. "crop"). | |
ImageToolkitOperation:: |
public | property | The id of the image toolkit plugin for which the operation is implemented. | |
Plugin:: |
protected | property | The plugin definition read from the class annotation. | 1 |
Plugin:: |
public | function |
Gets the value of an annotation. Overrides AnnotationInterface:: |
2 |
Plugin:: |
public | function |
Gets the class of the annotated class. Overrides AnnotationInterface:: |
|
Plugin:: |
public | function |
Gets the unique ID for this annotated class. Overrides AnnotationInterface:: |
|
Plugin:: |
public | function |
Gets the name of the provider of the annotated class. Overrides AnnotationInterface:: |
|
Plugin:: |
protected | function | Parses an annotation into its definition. | |
Plugin:: |
public | function |
Sets the class of the annotated class. Overrides AnnotationInterface:: |
|
Plugin:: |
public | function |
Sets the name of the provider of the annotated class. Overrides AnnotationInterface:: |
|
Plugin:: |
public | function | Constructs a Plugin object. | 1 |