1. class
  2. Bolt
  3. \
  4. Thumbs
  5. \
  6. ImageResource

ImageResource

class ImageResource (View source)

An object representation of GD's native image resources.

Note: Only the functionality needed has been implemented in this class.

Properties

protected resource $resource
protected Type $type
protected Info $info
static protected int $quality
static protected bool $normalizeJpegOrientation

Methods

__construct(resource $resource, Type $type = null, Info $info = null)

Constructor.

static ImageResource
createFromFile(string $file)

Creates an ImageResource from a file.

static ImageResource
createFromString(string $data)

Creates an ImageResource from a string of image data.

static ImageResource
createNew(Dimensions $dimensions, Type $type)

Creates a new image given the width and height.

resource
getResource()

Returns the GD resource.

Dimensions
getDimensions()

Returns the image dimensions.

Type
getType()

Returns the image type.

Info
getInfo()

Returns the image's info.

Exif
getExif()

No description

Color
allocateColor(int $red, int $green, int $blue, int|null $alpha = null)

Allocate a color for an image.

Color
allocateTransparentColor()

Allocate a transparent color for an image.

Color
getColorAt(Point $point)

Returns the color at a point.

ImageResource
fill(Color $color, Point $startPoint = null)

Flood fill.

ImageResource
resample(Point $destPoint, Point $srcPoint, Dimensions $destDimensions, Dimensions $srcDimensions, ImageResource $dest = null)

Resize part of an image with resampling.

ImageResource
flip(string $mode)

Flips the image.

ImageResource
rotate(string $angle)

Rotates the image.

toFile(string $file)

Writes the image to a file.

string
toString()

Returns the image as a data string.

__toString()

No description

__clone()

No description

__destroy()

No description

static boolean
isJpegOrientationNormalized()

Returns whether JPEG orientation is normalized or not.

static 
setNormalizeJpegOrientation(boolean $normalizeJpegOrientation)

Enable or disable JPEG orientation normalization.

static 
setQuality(int $quality)

Sets the quality setting.

static int
getQuality()

Returns the quality setting.

static int
convertJpegQualityToPngCompression(int $quality)

Convert JPEG quality scale to PNG compression scale.

static int
convertPngCompressionToJpegQuality(int $compression)

Convert PNG compression scale to JPEG quality scale.

normalizeJpegOrientation()

If orientation in EXIF data is not normal, flip and/or rotate image until it is correct

Color
verifyColor(Color $color)

Verifies that a color is allocated.

resetInfo()

If image changes, info needs to be recreated

Details

at line 40
__construct(resource $resource, Type $type = null, Info $info = null)

Constructor.

Either type or info need to be provided.

Parameters

resource $resource A GD resource
Type $type Image type
Info $info Image info

at line 68
static ImageResource createFromFile(string $file)

Creates an ImageResource from a file.

Parameters

string $file A filepath

Return Value

ImageResource

at line 98
static ImageResource createFromString(string $data)

Creates an ImageResource from a string of image data.

Parameters

string $data A string containing the image data

Return Value

ImageResource

at line 117
static ImageResource createNew(Dimensions $dimensions, Type $type)

Creates a new image given the width and height.

Parameters

Dimensions $dimensions Image dimensions
Type $type Type of image

Return Value

ImageResource

at line 136
resource getResource()

Returns the GD resource.

Return Value

resource

at line 146
Dimensions getDimensions()

Returns the image dimensions.

Return Value

Dimensions

at line 156
Type getType()

Returns the image type.

Return Value

Type

at line 166
Info getInfo()

Returns the image's info.

Return Value

Info

at line 178
Exif getExif()

Return Value

Exif

at line 193
Color allocateColor(int $red, int $green, int $blue, int|null $alpha = null)

Allocate a color for an image.

Parameters

int $red Value of red component (between 0 and 255)
int $green Value of green component (between 0 and 255)
int $blue Value of blue component (between 0 and 255)
int|null $alpha Optional value of alpha component (between 0 and 127). 0 = opaque, 127 = transparent.

Return Value

Color

at line 226
Color allocateTransparentColor()

Allocate a transparent color for an image.

Return Value

Color

at line 246
Color getColorAt(Point $point)

Returns the color at a point.

Parameters

Point $point

Return Value

Color

at line 269
ImageResource fill(Color $color, Point $startPoint = null)

Flood fill.

Parameters

Color $color The fill color
Point $startPoint The point to start at

Return Value

ImageResource This image

at line 289
ImageResource resample(Point $destPoint, Point $srcPoint, Dimensions $destDimensions, Dimensions $srcDimensions, ImageResource $dest = null)

Resize part of an image with resampling.

Parameters

Point $destPoint The destination point
Point $srcPoint The source point
Dimensions $destDimensions The destination dimensions
Dimensions $srcDimensions The source dimensions
ImageResource $dest Optional destination image. Default is current image.

Return Value

ImageResource This image

at line 326
ImageResource flip(string $mode)

Flips the image.

Based on http://stackoverflow.com/a/10001884/1136593 Thanks Jon Grant

Parameters

string $mode ('V' = vertical, 'H' = horizontal, 'HV' = both)

Return Value

ImageResource This image

at line 357
ImageResource rotate(string $angle)

Rotates the image.

Parameters

string $angle ('L' = -90°, 'R' = +90°, 'T' = 180°)

Return Value

ImageResource This image

at line 380
toFile(string $file)

Writes the image to a file.

Parameters

string $file

at line 407
string toString()

Returns the image as a data string.

Return Value

string

at line 427
__toString()

at line 439
__clone()

at line 455
__destroy()

at line 465
static boolean isJpegOrientationNormalized()

Returns whether JPEG orientation is normalized or not.

Return Value

boolean

at line 475
static setNormalizeJpegOrientation(boolean $normalizeJpegOrientation)

Enable or disable JPEG orientation normalization.

Parameters

boolean $normalizeJpegOrientation

at line 487
static setQuality(int $quality)

Sets the quality setting.

Note: A quality < 10 is assumed to be PNG compression scale.

Parameters

int $quality Between 0 and 100

at line 507
static int getQuality()

Returns the quality setting.

Return Value

int

at line 520
static protected int convertJpegQualityToPngCompression(int $quality)

Convert JPEG quality scale to PNG compression scale.

JPEG: 0 (worst) - 100 (best). PNG: 0 (best) - 10 (worst)

Parameters

int $quality

Return Value

int

at line 535
static protected int convertPngCompressionToJpegQuality(int $compression)

Convert PNG compression scale to JPEG quality scale.

Parameters

int $compression

Return Value

int

at line 544
protected normalizeJpegOrientation()

If orientation in EXIF data is not normal, flip and/or rotate image until it is correct

at line 563
protected Color verifyColor(Color $color)

Verifies that a color is allocated.

Parameters

Color $color

Return Value

Color

at line 575
protected resetInfo()

If image changes, info needs to be recreated