Documentation

AdapterInterface
in

Adapter interface

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

Copyright (c) 2009-2024 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

http://www.popphp.org/license New BSD License

version
4.0.0

Table of Contents

Methods

__toString()  : string
Output the image
adjust()  : AdjustInterface
Get the image adjust object
convert()  : AdapterInterface
Convert the image object to another format
create()  : AdapterInterface
Create a new image resource
createColor()  : mixed
Create and return a color.
createIndex()  : AdapterInterface
Create a new indexed image resource
createResource()  : void
Create the image resource
crop()  : AdapterInterface
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()  : AdapterInterface
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()  : AdapterInterface
Method to flip the image over the x-axis
flop()  : AdapterInterface
Method to flip the image over the y-axis
getColorspace()  : int
Get the colorspace
getExif()  : array<string|int, mixed>
Get the image EXIF data
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()  : AdapterInterface
Load the image resource from the existing image file
loadFromString()  : AdapterInterface
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()  : AdapterInterface
Resize the image object, allowing for the largest dimension to be scaled to the value of the $px argument.
resizeToHeight()  : AdapterInterface
Resize the image object to the height parameter passed
resizeToWidth()  : AdapterInterface
Resize the image object to the width parameter passed
rotate()  : Gd
Rotate the image object
scale()  : AdapterInterface
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

Methods

__toString()

Output the image

public __toString() : string
Return values
string

create()

Create a new image resource

public create([int|null $width = null ][, int|null $height = null ][, string|null $name = null ]) : AdapterInterface
Parameters
$width : int|null = null
$height : int|null = null
$name : string|null = null
Return values
AdapterInterface

createIndex()

Create a new indexed image resource

public createIndex([int|null $width = null ][, int|null $height = null ][, string|null $name = null ]) : AdapterInterface
Parameters
$width : int|null = null
$height : int|null = null
$name : string|null = null
Return values
AdapterInterface

createResource()

Create the image resource

public 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 crop(int $w, int $h[, int $x = 0 ][, int $y = 0 ]) : AdapterInterface
Parameters
$w : int
$h : int
$x : int = 0
$y : int = 0
Return values
AdapterInterface

cropThumb()

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 cropThumb(int $px[, int|null $offset = null ]) : AdapterInterface
Parameters
$px : int
$offset : int|null = null
Return values
AdapterInterface

destroy()

Destroy the image object and the related image file directly

public destroy([bool $delete = false ]) : void
Parameters
$delete : bool = false

getColorspace()

Get the colorspace

public getColorspace() : int
Return values
int

getExif()

Get the image EXIF data

public getExif() : array<string|int, mixed>
Return values
array<string|int, mixed>

getHeight()

Get the image height

public getHeight() : int
Return values
int

getName()

Get the image name

public getName() : string
Return values
string

getQuality()

Get the image quality

public getQuality() : int
Return values
int

getWidth()

Get the image width

public getWidth() : int
Return values
int

hasResource()

Determine if there is an image resource

public hasResource() : bool
Return values
bool

isCmyk()

Determine if the image is CMYK

public isCmyk() : bool
Return values
bool

isGray()

Determine if the image is grayscale

public isGray() : bool
Return values
bool

isIndexed()

Determine if the image is index color

public isIndexed() : bool
Return values
bool

isRgb()

Determine if the image is RGB

public isRgb() : bool
Return values
bool

outputToHttp()

Output the image object directly to HTTP

public 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
throws
Exception

outputToRawString()

Output the image object to a raw string

public outputToRawString([int $quality = 100 ]) : string|false
Parameters
$quality : int = 100
Tags
throws
Exception
Return values
string|false

sendHeaders()

Send image headers the image

public sendHeaders([string|null $to = null ][, bool $download = false ]) : void
Parameters
$to : string|null = null
$download : bool = false

setQuality()

Set the image quality

public setQuality(int $quality) : static
Parameters
$quality : int
Return values
static

writeToFile()

Write the image object to a file on disk

public writeToFile([string|null $to = null ][, int $quality = 100 ]) : void
Parameters
$to : string|null = null
$quality : int = 100
Tags
throws
Exception 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results