Interface

Imagine\Image\ManipulatorInterface

interface ManipulatorInterface

The manipulator interface

Constants

THUMBNAIL_INSET

THUMBNAIL_OUTBOUND

Methods

ManipulatorInterface copy()

Copies current source image into a new ImageInterface instance

ManipulatorInterface crop(PointInterface $start, BoxInterface $size)

Crops a specified box out of the source image (modifies the source image) Returns cropped self

ManipulatorInterface resize(BoxInterface $size, string $filter = ImageInterface::FILTER_UNDEFINED)

Resizes current image and returns self

ManipulatorInterface rotate(integer $angle, ColorInterface $background = null)

Rotates an image at the given angle.

ManipulatorInterface paste(ImageInterface $image, PointInterface $start)

Pastes an image into a parent image Throws exceptions if image exceeds parent image borders or if paste operation fails

ManipulatorInterface save(string $path = null, array $options = array())

Saves the image at a specified path, the target file extension is used to determine file format, only jpg, jpeg, gif, png, wbmp and xbm are supported

ManipulatorInterface show(string $format, array $options = array())

Outputs the image content

ManipulatorInterface flipHorizontally()

Flips current image using horizontal axis

ManipulatorInterface flipVertically()

Flips current image using vertical axis

ManipulatorInterface strip()

Remove all profiles and comments

ManipulatorInterface thumbnail(BoxInterface $size, string $mode = self::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED)

Generates a thumbnail from a current image Returns it as a new image, doesn't modify the current image

ManipulatorInterface applyMask(ImageInterface $mask)

Applies a given mask to current image's alpha channel

ManipulatorInterface fill(FillInterface $fill)

Fills image with provided filling, by replacing each pixel's color in the current image with corresponding color from FillInterface, and returns modified image

Details

at line 34
public ManipulatorInterface copy()

Copies current source image into a new ImageInterface instance

Return Value

ManipulatorInterface

Exceptions

RuntimeException

at line 48
public ManipulatorInterface crop(PointInterface $start, BoxInterface $size)

Crops a specified box out of the source image (modifies the source image) Returns cropped self

at line 60
public ManipulatorInterface resize(BoxInterface $size, string $filter = ImageInterface::FILTER_UNDEFINED)

Resizes current image and returns self

Parameters

BoxInterface $size
string $filter

Return Value

ManipulatorInterface

Exceptions

RuntimeException

at line 74
public ManipulatorInterface rotate(integer $angle, ColorInterface $background = null)

Rotates an image at the given angle.

Optional $background can be used to specify the fill color of the empty area of rotated image.

Parameters

integer $angle
ColorInterface $background

Return Value

ManipulatorInterface

Exceptions

RuntimeException

at line 92
public ManipulatorInterface paste(ImageInterface $image, PointInterface $start)

Pastes an image into a parent image Throws exceptions if image exceeds parent image borders or if paste operation fails

Returns source image

at line 106
public ManipulatorInterface save(string $path = null, array $options = array())

Saves the image at a specified path, the target file extension is used to determine file format, only jpg, jpeg, gif, png, wbmp and xbm are supported

Parameters

string $path
array $options

Return Value

ManipulatorInterface

Exceptions

RuntimeException

at line 118
public ManipulatorInterface show(string $format, array $options = array())

Outputs the image content

Parameters

string $format
array $options

Return Value

ManipulatorInterface

Exceptions

RuntimeException

at line 127
public ManipulatorInterface flipHorizontally()

Flips current image using horizontal axis

Return Value

ManipulatorInterface

Exceptions

RuntimeException

at line 136
public ManipulatorInterface flipVertically()

Flips current image using vertical axis

Return Value

ManipulatorInterface

Exceptions

RuntimeException

at line 145
public ManipulatorInterface strip()

Remove all profiles and comments

Return Value

ManipulatorInterface

Exceptions

RuntimeException

at line 159
public ManipulatorInterface thumbnail(BoxInterface $size, string $mode = self::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED)

Generates a thumbnail from a current image Returns it as a new image, doesn't modify the current image

Parameters

BoxInterface $size
string $mode
string $filter The filter to use for resizing, one of ImageInterface::FILTER_*

Return Value

ManipulatorInterface

Exceptions

RuntimeException

at line 168
public ManipulatorInterface applyMask(ImageInterface $mask)

Applies a given mask to current image's alpha channel

Parameters

ImageInterface $mask

Return Value

ManipulatorInterface

at line 179
public ManipulatorInterface fill(FillInterface $fill)

Fills image with provided filling, by replacing each pixel's color in the current image with corresponding color from FillInterface, and returns modified image

Parameters

FillInterface $fill

Return Value

ManipulatorInterface