1. interface
  2. Drupal
  3. \
  4. Core
  5. \
  6. ImageToolkit
  7. \
  8. ImageToolkitOperationInterface

ImageToolkitOperationInterface

interface ImageToolkitOperationInterface implements PluginInspectionInterface (View source)

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.

Methods

string
getPluginId()

Gets the plugin_id of the plugin instance.

from  PluginInspectionInterface
array
getPluginDefinition()

Gets the definition of the plugin implementation.

from  PluginInspectionInterface
bool
apply(array $arguments)

Applies a toolkit specific operation to an image.

Details

in PluginInspectionInterface at line 21
string getPluginId()

Gets the plugin_id of the plugin instance.

Return Value

string

The plugin_id of the plugin instance.

in PluginInspectionInterface at line 30
array getPluginDefinition()

Gets the definition of the plugin implementation.

Return Value

array

The plugin definition, as returned by the discovery object used by the plugin manager.

at line 33
bool apply(array $arguments)

Applies a toolkit specific operation to an image.

Parameters

array $arguments

An associative array of data to be used by the toolkit operation.

Return Value

bool

TRUE if the operation was performed successfully, FALSE otherwise.

Exceptions

InvalidArgumentException