AbstractAdapter
in package
implements
AdapterInterface
AbstractYes
Abstract adapter class
Tags
Table of Contents
Interfaces
- AdapterInterface
- Adapter interface
Constants
- IMAGE_CMYK = 3
- IMAGE_GRAY = 1
- Colorspace constants
- IMAGE_RGB = 2
Properties
- $adjust : AdjustInterface|null
- Image adjust object
- $colorspace : int
- Image colorspace
- $draw : DrawInterface|null
- Image draw object
- $effect : EffectInterface|null
- Image effect object
- $exif : array<string|int, mixed>
- EXIF data
- $filter : FilterInterface|null
- Image filter object
- $format : string
- Image format
- $height : int
- Image height
- $indexed : bool
- Index color flag
- $layer : LayerInterface|null
- Image layer object
- $name : string
- Image name
- $quality : int
- Image quality
- $resource : mixed
- Image resource
- $type : TypeInterface|null
- Image type object
- $width : int
- Image width
Methods
- __construct() : mixed
- Constructor
- __get() : mixed
- Magic get method to return a manipulation object
- __toString() : string
- Output the image
- adjust() : AdjustInterface
- Get the image adjust object
- convert() : AbstractAdapter
- Convert the image object to another format
- create() : AbstractAdapter
- Create a new image resource
- createColor() : mixed
- Create and return a color.
- createIndex() : AbstractAdapter
- Create a new indexed image resource
- createResource() : void
- Create the image resource
- crop() : AbstractAdapter
- Crop the image object to a image whose dimensions are based on the value of the $wid and $hgt argument. The optional $x and $y arguments allow for the adjustment of the crop to select a certain area of the image to be cropped.
- cropThumb() : AbstractAdapter
- Crop the image object to a square image whose dimensions are based on the value of the $px argument. The optional $offset argument allows for the adjustment of the crop to select a certain area of the image to be cropped.
- destroy() : void
- Destroy the image object and the related image file directly
- draw() : DrawInterface
- Get the image draw object
- effect() : EffectInterface
- Get the image effect object
- filter() : FilterInterface
- Get the image filter object
- flip() : AbstractAdapter
- Method to flip the image over the x-axis
- flop() : AbstractAdapter
- Method to flip the image over the y-axis
- getColorspace() : int
- Get the colorspace
- getExif() : array<string|int, mixed>
- Get the image EXIF data
- getFormat() : string
- Get the image format
- getHeight() : int
- Get the image height
- getName() : string
- Get the image name
- getQuality() : int
- Get the image quality
- getResource() : mixed
- Get the image resource
- getWidth() : int
- Get the image width
- hasResource() : bool
- Determine if there is an image resource
- isCmyk() : bool
- Determine if the image is CMYK
- isGray() : bool
- Determine if the image is grayscale
- isIndexed() : bool
- Determine if the image is index color
- isRgb() : bool
- Determine if the image is RGB
- layer() : LayerInterface
- Get the image layer object
- load() : AbstractAdapter
- Load the image resource from the existing image file
- loadFromString() : AbstractAdapter
- Load the image resource from data
- outputToHttp() : void
- Output the image object directly to HTTP
- outputToRawString() : string|false
- Output the image object to a raw string
- resize() : AbstractAdapter
- Resize the image object, allowing for the largest dimension to be scaled to the value of the $px argument.
- resizeToHeight() : AbstractAdapter
- Resize the image object to the height parameter passed
- resizeToWidth() : AbstractAdapter
- Resize the image object to the width parameter passed
- rotate() : AbstractAdapter
- Rotate the image object
- scale() : AbstractAdapter
- Scale the image object, allowing for the dimensions to be scaled proportionally to the value of the $scl argument.
- sendHeaders() : void
- Send image headers the image
- setQuality() : static
- Set the image quality
- type() : TypeInterface
- Get the image type object
- writeToFile() : void
- Write the image object to a file on disk
Constants
IMAGE_CMYK
public
mixed
IMAGE_CMYK
= 3
IMAGE_GRAY
Colorspace constants
public
mixed
IMAGE_GRAY
= 1
IMAGE_RGB
public
mixed
IMAGE_RGB
= 2
Properties
$adjust
Image adjust object
protected
AdjustInterface|null
$adjust
= null
$colorspace
Image colorspace
protected
int
$colorspace
= 2
$draw
Image draw object
protected
DrawInterface|null
$draw
= null
$effect
Image effect object
protected
EffectInterface|null
$effect
= null
$exif
EXIF data
protected
array<string|int, mixed>
$exif
= []
$filter
Image filter object
protected
FilterInterface|null
$filter
= null
$format
Image format
protected
string
$format
= 'jpg'
$height
Image height
protected
int
$height
= 480
$indexed
Index color flag
protected
bool
$indexed
= false
$layer
Image layer object
protected
LayerInterface|null
$layer
= null
$name
Image name
protected
string
$name
= 'pop-image.jpg'
$quality
Image quality
protected
int
$quality
= 100
$resource
Image resource
protected
mixed
$resource
= null
$type
Image type object
protected
TypeInterface|null
$type
= null
$width
Image width
protected
int
$width
= 640
Methods
__construct()
Constructor
public
__construct() : mixed
Instantiate an image object based on either a pre-existing image file on disk, or a new image file.
__get()
Magic get method to return a manipulation object
public
__get(string $name) : mixed
Parameters
- $name : string
__toString()
Output the image
public
abstract __toString() : string
Return values
stringadjust()
Get the image adjust object
public
abstract adjust() : AdjustInterface
Return values
AdjustInterfaceconvert()
Convert the image object to another format
public
abstract convert(string $type) : AbstractAdapter
Parameters
- $type : string
Tags
Return values
AbstractAdaptercreate()
Create a new image resource
public
abstract create([int|null $width = null ][, int|null $height = null ][, string|null $name = null ]) : AbstractAdapter
Parameters
- $width : int|null = null
- $height : int|null = null
- $name : string|null = null
Return values
AbstractAdaptercreateColor()
Create and return a color.
public
abstract createColor([ColorInterface|null $color = null ][, int $alpha = 100 ]) : mixed
Parameters
- $color : ColorInterface|null = null
- $alpha : int = 100
Tags
createIndex()
Create a new indexed image resource
public
abstract createIndex([int|null $width = null ][, int|null $height = null ][, string|null $name = null ]) : AbstractAdapter
Parameters
- $width : int|null = null
- $height : int|null = null
- $name : string|null = null
Return values
AbstractAdaptercreateResource()
Create the image resource
public
abstract createResource() : void
crop()
Crop the image object to a image whose dimensions are based on the value of the $wid and $hgt argument. The optional $x and $y arguments allow for the adjustment of the crop to select a certain area of the image to be cropped.
public
abstract crop(int $w, int $h[, int $x = 0 ][, int $y = 0 ]) : AbstractAdapter
Parameters
- $w : int
- $h : int
- $x : int = 0
- $y : int = 0
Return values
AbstractAdaptercropThumb()
Crop the image object to a square image whose dimensions are based on the value of the $px argument. The optional $offset argument allows for the adjustment of the crop to select a certain area of the image to be cropped.
public
abstract cropThumb(int $px[, int|null $offset = null ]) : AbstractAdapter
Parameters
- $px : int
- $offset : int|null = null
Return values
AbstractAdapterdestroy()
Destroy the image object and the related image file directly
public
abstract destroy([bool $delete = false ]) : void
Parameters
- $delete : bool = false
draw()
Get the image draw object
public
abstract draw() : DrawInterface
Return values
DrawInterfaceeffect()
Get the image effect object
public
abstract effect() : EffectInterface
Return values
EffectInterfacefilter()
Get the image filter object
public
abstract filter() : FilterInterface
Return values
FilterInterfaceflip()
Method to flip the image over the x-axis
public
abstract flip() : AbstractAdapter
Return values
AbstractAdapterflop()
Method to flip the image over the y-axis
public
abstract flop() : AbstractAdapter
Return values
AbstractAdaptergetColorspace()
Get the colorspace
public
getColorspace() : int
Return values
intgetExif()
Get the image EXIF data
public
getExif() : array<string|int, mixed>
Return values
array<string|int, mixed>getFormat()
Get the image format
public
getFormat() : string
Return values
stringgetHeight()
Get the image height
public
getHeight() : int
Return values
intgetName()
Get the image name
public
getName() : string
Return values
stringgetQuality()
Get the image quality
public
getQuality() : int
Return values
intgetResource()
Get the image resource
public
getResource() : mixed
getWidth()
Get the image width
public
getWidth() : int
Return values
inthasResource()
Determine if there is an image resource
public
hasResource() : bool
Return values
boolisCmyk()
Determine if the image is CMYK
public
isCmyk() : bool
Return values
boolisGray()
Determine if the image is grayscale
public
isGray() : bool
Return values
boolisIndexed()
Determine if the image is index color
public
isIndexed() : bool
Return values
boolisRgb()
Determine if the image is RGB
public
isRgb() : bool
Return values
boollayer()
Get the image layer object
public
abstract layer() : LayerInterface
Return values
LayerInterfaceload()
Load the image resource from the existing image file
public
abstract load([string|null $name = null ]) : AbstractAdapter
Parameters
- $name : string|null = null
Return values
AbstractAdapterloadFromString()
Load the image resource from data
public
abstract loadFromString(string $data[, string|null $name = null ]) : AbstractAdapter
Parameters
- $data : string
- $name : string|null = null
Return values
AbstractAdapteroutputToHttp()
Output the image object directly to HTTP
public
abstract outputToHttp([int $quality = 100 ][, string|null $to = null ][, bool $download = false ][, bool $sendHeaders = true ]) : void
Parameters
- $quality : int = 100
- $to : string|null = null
- $download : bool = false
- $sendHeaders : bool = true
Tags
outputToRawString()
Output the image object to a raw string
public
abstract outputToRawString([int $quality = 100 ]) : string|false
Parameters
- $quality : int = 100
Tags
Return values
string|falseresize()
Resize the image object, allowing for the largest dimension to be scaled to the value of the $px argument.
public
abstract resize(int $px) : AbstractAdapter
Parameters
- $px : int
Return values
AbstractAdapterresizeToHeight()
Resize the image object to the height parameter passed
public
abstract resizeToHeight(int $h) : AbstractAdapter
Parameters
- $h : int
Return values
AbstractAdapterresizeToWidth()
Resize the image object to the width parameter passed
public
abstract resizeToWidth(int $w) : AbstractAdapter
Parameters
- $w : int
Return values
AbstractAdapterrotate()
Rotate the image object
public
abstract rotate(int $degrees[, ColorInterface|null $bgColor = null ]) : AbstractAdapter
Parameters
- $degrees : int
- $bgColor : ColorInterface|null = null
Tags
Return values
AbstractAdapterscale()
Scale the image object, allowing for the dimensions to be scaled proportionally to the value of the $scl argument.
public
abstract scale(float $scale) : AbstractAdapter
Parameters
- $scale : float
Return values
AbstractAdaptersendHeaders()
Send image headers the image
public
sendHeaders([string|null $to = null ][, bool $download = false ][, array<string|int, mixed> $additionalHeaders = [] ]) : void
Parameters
- $to : string|null = null
- $download : bool = false
- $additionalHeaders : array<string|int, mixed> = []
setQuality()
Set the image quality
public
setQuality(int $quality) : static
Parameters
- $quality : int
Tags
Return values
statictype()
Get the image type object
public
abstract type() : TypeInterface
Return values
TypeInterfacewriteToFile()
Write the image object to a file on disk
public
abstract writeToFile([string|null $to = null ][, int $quality = 100 ]) : void
Parameters
- $to : string|null = null
- $quality : int = 100