Documentation

Encoder extends AbstractEncoder
in package

Table of Contents

Properties

$format  : string
Output format of encoder instance
$image  : Image
Image object to encode
$quality  : int
Output quality of encoder instance
$result  : string
Buffer of encode result data

Methods

process()  : Image
Process a given image
processAvif()  : string
Processes and returns encoded image as AVIF string
processBmp()  : string
Processes and returns encoded image as BMP string
processDataUrl()  : string
Processes and returns encoded image as data-url string
processGif()  : string
Processes and returns encoded image as GIF string
processIco()  : string
Processes and returns encoded image as ICO string
processJpeg()  : string
Processes and returns encoded image as JPEG string
processPng()  : string
Processes and returns encoded image as PNG string
processPsd()  : string
Processes and returns encoded image as PSD string
processTiff()  : string
Processes and returns encoded image as TIFF string
processWebp()  : string
Processes and returns image as WebP encoded string
setFormat()  : mixed
Determines output format
setImage()  : mixed
Sets image to process
setQuality()  : mixed
Determines output quality

Properties

Methods

process()

Process a given image

public process(Image $image[, string $format = null ][, int $quality = null ]) : Image
Parameters
$image : Image
$format : string = null
$quality : int = null
Return values
Image

processAvif()

Processes and returns encoded image as AVIF string

protected processAvif() : string
Return values
string

processBmp()

Processes and returns encoded image as BMP string

protected processBmp() : string
Return values
string

processDataUrl()

Processes and returns encoded image as data-url string

protected processDataUrl() : string
Return values
string

processGif()

Processes and returns encoded image as GIF string

protected processGif() : string
Return values
string

processIco()

Processes and returns encoded image as ICO string

protected processIco() : string
Return values
string

processJpeg()

Processes and returns encoded image as JPEG string

protected processJpeg() : string
Return values
string

processPng()

Processes and returns encoded image as PNG string

protected processPng() : string
Return values
string

processPsd()

Processes and returns encoded image as PSD string

protected processPsd() : string
Return values
string

processTiff()

Processes and returns encoded image as TIFF string

protected processTiff() : string
Return values
string

processWebp()

Processes and returns image as WebP encoded string

protected processWebp() : string
Return values
string

setFormat()

Determines output format

protected setFormat([string $format = null ]) : mixed
Parameters
$format : string = null

setQuality()

Determines output quality

protected setQuality(int $quality) : mixed
Parameters
$quality : int

        
On this page

Search results