interface ImageToolkitOperationInterface
Defines an interface for image toolkit operations.
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.
Hierarchy
- interface \Drupal\Component\Plugin\PluginInspectionInterface
- interface \Drupal\Core\ImageToolkit\ImageToolkitOperationInterface extends \Drupal\Component\Plugin\PluginInspectionInterface
Expanded class hierarchy of ImageToolkitOperationInterface
All classes that implement ImageToolkitOperationInterface
See also
\Drupal\Core\ImageToolkit\Annotation\ImageToolkitOperation
\Drupal\Core\ImageToolkit\ImageToolkitOperationBase
\Drupal\Core\ImageToolkit\ImageToolkitOperationManager
File
-
core/
lib/ Drupal/ Core/ ImageToolkit/ ImageToolkitOperationInterface.php, line 19
Namespace
Drupal\Core\ImageToolkitView source
interface ImageToolkitOperationInterface extends PluginInspectionInterface {
/**
* Applies a toolkit specific operation to an image.
*
* @param array $arguments
* An associative array of data to be used by the toolkit operation.
*
* @return bool
* TRUE if the operation was performed successfully, FALSE otherwise.
*
* @throws \InvalidArgumentException
* If one or more of the arguments are not valid.
*/
public function apply(array $arguments);
}Members
| Title Sort descending | Modifiers | Object type | Summary | Overrides |
|---|---|---|---|---|
| ImageToolkitOperationInterface::apply | public | function | Applies a toolkit specific operation to an image. | 1 |
| PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 5 |
| PluginInspectionInterface::getPluginId | public | function | Gets the plugin ID of the plugin instance. | 2 |