interface ImageToolkitInterface

Defines an interface for image toolkits.

An image toolkit provides common image file manipulations like scaling, cropping, and rotating.

Hierarchy

• interface \Drupal\Core\Plugin\ContainerFactoryPluginInterface; interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Core\Plugin\PluginFormInterface
  • interface \Drupal\Core\ImageToolkit\ImageToolkitInterface

See also

\Drupal\Core\ImageToolkit\Annotation\ImageToolkit

\Drupal\Core\ImageToolkit\ImageToolkitBase

\Drupal\Core\ImageToolkit\ImageToolkitManager

Plugin API

Related topics

Image toolkits

Functions for image file manipulations.

File

core/lib/Drupal/Core/ImageToolkit/ImageToolkitInterface.php, line 47

Namespace

Drupal\Core\ImageToolkit

Members

Name	Modifiers	Type	Description
ContainerFactoryPluginInterface::create	public static	function	Creates an instance of the plugin.
ImageToolkitInterface::apply	public	function	Applies a toolkit operation to an image.
ImageToolkitInterface::getHeight	public	function	Returns the height of the image.
ImageToolkitInterface::getMimeType	public	function	Returns the MIME type of the image file.
ImageToolkitInterface::getRequirements	public	function	Gets toolkit requirements in a format suitable for hook_requirements().
ImageToolkitInterface::getSource	public	function	Gets the source path of the image file.
ImageToolkitInterface::getSupportedExtensions	public static	function	Returns a list of image file extensions supported by the toolkit.
ImageToolkitInterface::getWidth	public	function	Returns the width of the image.
ImageToolkitInterface::isAvailable	public static	function	Verifies that the Image Toolkit is set up correctly.
ImageToolkitInterface::isValid	public	function	Checks if the image is valid.
ImageToolkitInterface::parseFile	public	function	Determines if a file contains a valid image.
ImageToolkitInterface::save	public	function	Writes an image resource to a destination file.
ImageToolkitInterface::setSource	public	function	Sets the source path of the image file.
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.