1. class
  2. mako
  3. \
  4. pixl
  5. \
  6. processors
  7. \
  8. GD

GD

class GD implements ProcessorInterface

GD processor.

Traits

CalculateNewDimensionsTrait
Calculate new image dimensions.

Properties

protected resource $image Image resource.
protected resource $snapshot Image resource.
protected array $imageInfo Image info.
protected bool $hasFilters Do we have the imagefilter function?

Methods

array
calculateNewDimensions(int $width, int $height, int $oldWidth, int $oldHeight, int $aspectRatio)

Calculates new image dimensions.

from CalculateNewDimensionsTrait
__construct()

Constructor.

__destruct()

Destructor.

resource
getImageInfo(string $file)

Collects information about the image.

resource
createImageResource(string $image, array $imageInfo)

Creates an image resource that we can work with.

array
hexToRgb(string $hex)

Converts HEX value to an RGB array.

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

in CalculateNewDimensionsTrait at line 32
protected array calculateNewDimensions(int $width, int $height, int $oldWidth, int $oldHeight, int $aspectRatio)

Calculates new image dimensions.

Parameters

int $width Desired image width
int $height Desired image height
int $oldWidth Old image width
int $oldHeight Old image height
int $aspectRatio Aspect ratio

Return Value

array

at line 101
__construct()

Constructor.

at line 109
__destruct()

Destructor.

at line 129
protected resource getImageInfo(string $file)

Collects information about the image.

Parameters

string $file Path to image file

Return Value

resource

Exceptions

RuntimeException

at line 149
protected resource createImageResource(string $image, array $imageInfo)

Creates an image resource that we can work with.

Parameters

string $image Path to image file
array $imageInfo Image info

Return Value

resource

Exceptions

RuntimeException

at line 174
protected array hexToRgb(string $hex)

Converts HEX value to an RGB array.

Parameters

string $hex HEX value

Return Value

array

Exceptions

InvalidArgumentException

at line 202
open(string $image)

Opens the image we want to work with.

Parameters

string $image Path to image file

at line 212
snapshot()

Creates a snapshot of the image resource.

at line 225
restore()

Restores an image snapshot.

Exceptions

RuntimeException

at line 240
int getWidth()

Returns the image width in pixels.

Return Value

int

at line 248
int getHeight()

Returns the image height in pixels.

Return Value

int

at line 256
array getDimensions()

Returns an array containing the image dimensions in pixels.

Return Value

array

at line 264
rotate(int $degrees)

Rotates the image using the given angle in degrees.

Parameters

int $degrees Degrees to rotate the image

at line 292
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 317
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 340
flip(int $direction = Image::FLIP_HORIZONTAL)

Flips the image.

Parameters

int $direction Direction to flip the image

at line 380
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 435
brightness(int $level = 50)

Adjust image brightness.

Parameters

int $level Brightness level (-100 to 100)

at line 479
greyscale()

Converts image to greyscale.

at line 526
sepia()

Converts image to sepia.

at line 565
bitonal()

Converts image to bitonal.

at line 607
colorize(string $color)

Colorize the image.

Parameters

string $color Hex value

at line 653
sharpen()

Sharpens the image.

at line 665
pixelate(int $pixelSize = 10)

Pixelates the image.

Parameters

int $pixelSize Pixel size

at line 685
negate()

Negates the image.

at line 717
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 746
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 782
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