interface ImageToolkitOperationInterface in Drupal 10

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

See also

\Drupal\Core\ImageToolkit\Annotation\ImageToolkitOperation

\Drupal\Core\ImageToolkit\ImageToolkitOperationBase

\Drupal\Core\ImageToolkit\ImageToolkitOperationManager

Plugin API

File

core/lib/Drupal/Core/ImageToolkit/ImageToolkitOperationInterface.php, line 19

Namespace

Drupal\Core\ImageToolkit

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);

}