1. interface
  2. mako
  3. \
  4. pixl
  5. \
  6. processors
  7. \
  8. ProcessorInterface

ProcessorInterface

interface ProcessorInterface

Image manipulation processor interface.

Methods

open(string $image)

Opens the image we want to work with.

snapshot()

Creates a snapshot of the image resource.

restore()

Restores an image snapshot.

int
getWidth()

Returns the image width in pixels.

int
getHeight()

Returns the image height in pixels.

array
getDimensions()

Returns an array containing the image dimensions in pixels.

rotate(int $degrees)

Rotates the image using the given angle in degrees.

resize(int $width, int $height = null, int $aspectRatio = Image::RESIZE_IGNORE)

Resizes the image to the chosen size.

crop(int $width, int $height, int $x, int $y)

Crops the image.

flip(int $direction = Image::FLIP_HORIZONTAL)

Flips the image.

watermark(string $file, int $position = Image::WATERMARK_TOP_LEFT, int $opacity = 100)

Adds a watermark to the image.

brightness(int $level = 50)

Adjust image brightness.

greyscale()

Converts image to greyscale.

sepia()

Converts image to sepia.

bitonal()

Converts image to bitonal.

colorize(string $color)

Colorize the image.

sharpen()

Sharpens the image.

pixelate(int $pixelSize = 10)

Pixelates the image.

negate()

Negates the image.

border(string $color = '#000', int $thickness = 5)

Adds a border to the image.

string
getImageBlob(string $type = null, int $quality = 95)

Returns a string containing the image.

save(string $file, int $quality = 95)

Saves image to file.

Details

at line 24
open(string $image)

Opens the image we want to work with.

Parameters

string $image Path to image file

at line 29
snapshot()

Creates a snapshot of the image resource.

at line 36
restore()

Restores an image snapshot.

Exceptions

RuntimeException

at line 43
int getWidth()

Returns the image width in pixels.

Return Value

int

at line 50
int getHeight()

Returns the image height in pixels.

Return Value

int

at line 57
array getDimensions()

Returns an array containing the image dimensions in pixels.

Return Value

array

at line 64
rotate(int $degrees)

Rotates the image using the given angle in degrees.

Parameters

int $degrees Degrees to rotate the image

at line 73
resize(int $width, int $height = null, int $aspectRatio = Image::RESIZE_IGNORE)

Resizes the image to the chosen size.

Parameters

int $width Width of the image
int $height Height of the image
int $aspectRatio Aspect ratio

at line 83
crop(int $width, int $height, int $x, int $y)

Crops the image.

Parameters

int $width Width of the crop
int $height Height of the crop
int $x The X coordinate of the cropped region's top left corner
int $y The Y coordinate of the cropped region's top left corner

at line 90
flip(int $direction = Image::FLIP_HORIZONTAL)

Flips the image.

Parameters

int $direction Direction to flip the image

at line 99
watermark(string $file, int $position = Image::WATERMARK_TOP_LEFT, int $opacity = 100)

Adds a watermark to the image.

Parameters

string $file Path to the image file
int $position Position of the watermark
int $opacity Opacity of the watermark in percent

at line 106
brightness(int $level = 50)

Adjust image brightness.

Parameters

int $level Brightness level (-100 to 100)

at line 111
greyscale()

Converts image to greyscale.

at line 116
sepia()

Converts image to sepia.

at line 121
bitonal()

Converts image to bitonal.

at line 128
colorize(string $color)

Colorize the image.

Parameters

string $color Hex value

at line 133
sharpen()

Sharpens the image.

at line 140
pixelate(int $pixelSize = 10)

Pixelates the image.

Parameters

int $pixelSize Pixel size

at line 145
negate()

Negates the image.

at line 153
border(string $color = '#000', int $thickness = 5)

Adds a border to the image.

Parameters

string $color Hex code for the color
int $thickness Thickness of the frame in pixels

at line 163
string getImageBlob(string $type = null, int $quality = 95)

Returns a string containing the image.

Parameters

string $type Image type
int $quality Image quality 1-100

Return Value

string

Exceptions

RuntimeException

at line 172
save(string $file, int $quality = 95)

Saves image to file.

Parameters

string $file Path to the image file
int $quality Image quality 1-100

Exceptions

RuntimeException