Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/ImageToolkit/ImageToolkitOperationInterface.php

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Core\ImageToolkit\ImageToolkitOperationInterface.
6	*/
7
8	namespace Drupal\Core\ImageToolkit;
9
10	use Drupal\Component\Plugin\PluginInspectionInterface;
11
12	/**
13	* Defines an interface for image toolkit operations.
14	*
15	* An image toolkit operation plugin provides a self-contained image
16	* manipulation routine, for a specific image toolkit. Examples of image
17	* toolkit operations are scaling, cropping, rotating, etc.
18	*
19	* @see \Drupal\Core\ImageToolkit\Annotation\ImageToolkitOperation
20	* @see \Drupal\Core\ImageToolkit\ImageToolkitOperationBase
21	* @see \Drupal\Core\ImageToolkit\ImageToolkitOperationManager
22	* @see plugin_api
23	*/
24	interface ImageToolkitOperationInterface extends PluginInspectionInterface {
25
26	/**
27	* Applies a toolkit specific operation to an image.
28	*
29	* @param array $arguments
30	* An associative array of data to be used by the toolkit operation.
31	*
32	* @return bool
33	* TRUE if the operation was performed successfully, FALSE otherwise.
34	*
35	* @throws \InvalidArgumentException
36	* If one or more of the arguments are not valid.
37	*/
38	public function apply(array $arguments);
39
40	}