Phalcon Image

Image\Adapter\AbstractAdapter

All image adapters must use this class

Uses Phalcon\Image\Enum · Phalcon\Image\Exception · Phalcon\Image\Exceptions\MissingDimensions · Phalcon\Image\Exceptions\MissingHeight · Phalcon\Image\Exceptions\MissingWidth

Method Summary

Properties

Methods

background()

public function background(
    string $color,
    int $opacity = 100
): AdapterInterface;

Set the background color of an image

blur()

public function blur( int $radius ): AdapterInterface;

Blur image

crop()

public function crop(
    int $width,
    int $height,
    mixed $offsetX = null,
    mixed $offsetY = null
): AdapterInterface;

Crop an image to the given size

flip()

public function flip( int $direction ): AdapterInterface;

Flip the image along the horizontal or vertical axis

getHeight()

public function getHeight(): int;

getImage()

public function getImage();

getMime()

public function getMime(): string;

getRealpath()

public function getRealpath(): string;

getType()

public function getType(): int;

getWidth()

public function getWidth(): int;

mask()

public function mask( AdapterInterface $mask ): AdapterInterface;

Composite one image onto another

pixelate()

public function pixelate( int $amount ): AdapterInterface;

Pixelate image

reflection()

public function reflection(
    int $height,
    int $opacity = 100,
    bool $fadeIn = false
): AdapterInterface;

Add a reflection to an image

render()

public function render(
    string $extension = null,
    int $quality = 100
): string;

Render the image and return the binary string

resize()

public function resize(
    int $width = null,
    int $height = null,
    int $master = Enum::AUTO
): AdapterInterface;

Resize the image to the given size

rotate()

public function rotate( int $degrees ): AdapterInterface;

Rotate the image by a given amount

save()

public function save(
    string $file = null,
    int $quality = -1
): AdapterInterface;

Save the image

sharpen()

public function sharpen( int $amount ): AdapterInterface;

Sharpen the image by a given amount

text()

public function text(
    string $text,
    mixed $offsetX = false,
    mixed $offsetY = false,
    int $opacity = 100,
    string $color = "000000",
    int $size = 12,
    string $fontFile = null
): AdapterInterface;

Add a text to an image with a specified opacity

watermark()

public function watermark(
    AdapterInterface $watermark,
    int $offsetX = 0,
    int $offsetY = 0,
    int $opacity = 100
): AdapterInterface;

Add a watermark to an image with the specified opacity

checkHighLow()

protected function checkHighLow(
    int $value,
    int $min = 0,
    int $max = 100
): int;

Image\Adapter\AdapterInterface

Interface for Phalcon\Image\Adapter classes

Uses Phalcon\Image\Enum

Method Summary

Methods

background()

public function background(
    string $color,
    int $opacity = 100
): AdapterInterface;

Add a background to an image

blur()

public function blur( int $radius ): AdapterInterface;

Blur an image

crop()

public function crop(
    int $width,
    int $height,
    int $offsetX = null,
    int $offsetY = null
): AdapterInterface;

Crop an image

flip()

public function flip( int $direction ): AdapterInterface;

Flip an image

getHeight()

public function getHeight(): int;

getWidth()

public function getWidth(): int;

mask()

public function mask( AdapterInterface $mask ): AdapterInterface;

Add a mask to an image

pixelate()

public function pixelate( int $amount ): AdapterInterface;

Pixelate an image

reflection()

public function reflection(
    int $height,
    int $opacity = 100,
    bool $fadeIn = false
): AdapterInterface;

Reflect an image

render()

public function render(
    string $extension = null,
    int $quality = 100
): string;

Render an image

resize()

public function resize(
    int $width = null,
    int $height = null,
    int $master = Enum::AUTO
): AdapterInterface;

Resize an image

rotate()

public function rotate( int $degrees ): AdapterInterface;

Rotate an image

save()

public function save(
    string $file = null,
    int $quality = 100
): AdapterInterface;

Save an image

sharpen()

public function sharpen( int $amount ): AdapterInterface;

Sharpen an image

text()

public function text(
    string $text,
    int $offsetX = 0,
    int $offsetY = 0,
    int $opacity = 100,
    string $color = "000000",
    int $size = 12,
    string $fontFile = null
): AdapterInterface;

Adds text on an image

watermark()

public function watermark(
    AdapterInterface $watermark,
    int $offsetX = 0,
    int $offsetY = 0,
    int $opacity = 100
): AdapterInterface;

Add a watermark on an image

Image\Adapter\Gd

This file is part of the Phalcon Framework.

(c) Phalcon Team <[email protected]>

For the full copyright and license information, please view the LICENSE.txt file that was distributed with this source code.

Uses Phalcon\Image\Enum · Phalcon\Image\Exception · Phalcon\Image\Exceptions\ExtensionNotLoaded · Phalcon\Image\Exceptions\ImageLoadFailed · Phalcon\Image\Exceptions\TextRenderingFailed · Phalcon\Image\Exceptions\UnsupportedImageType · Phalcon\Image\Exceptions\VersionMismatch

Method Summary

Methods

__construct()

public function __construct(
    string $file,
    int $width = null,
    int $height = null
);

__destruct()

public function __destruct();

Destructor

getVersion()

public function getVersion(): string;

processBackground()

protected function processBackground(
    int $red,
    int $green,
    int $blue,
    int $opacity
): void;

processBlur()

protected function processBlur( int $radius ): void;

processCreate()

protected function processCreate(
    int $width,
    int $height
);

processCrop()

protected function processCrop(
    int $width,
    int $height,
    int $offsetX,
    int $offsetY
): void;

processFlip()

protected function processFlip( int $direction ): void;

processMask()

protected function processMask( AdapterInterface $mask );

processPixelate()

protected function processPixelate( int $amount ): void;

processReflection()

protected function processReflection(
    int $height,
    int $opacity,
    bool $fadeIn
): void;

processRender()

protected function processRender(
    string $extension,
    int $quality
);

processResize()

protected function processResize(
    int $width,
    int $height
): void;

processRotate()

protected function processRotate( int $degrees ): void;

processSave()

protected function processSave(
    string $file,
    int $quality
): bool;

processSharpen()

protected function processSharpen( int $amount ): void;

processText()

protected function processText(
    string $text,
    mixed $offsetX,
    mixed $offsetY,
    int $opacity,
    int $red,
    int $green,
    int $blue,
    int $size,
    string $fontFile = null
): void;

processWatermark()

protected function processWatermark(
    AdapterInterface $watermark,
    int $offsetX,
    int $offsetY,
    int $opacity
): void;

Image\Adapter\Imagick

Phalcon\Image\Adapter\Imagick

Image manipulation support. Resize, rotate, crop etc.

$image = new \Phalcon\Image\Adapter\Imagick("upload/test.jpg");

$image->resize(200, 200)->rotate(90)->crop(100, 100);

if ($image->save()) {
    echo "success";
}

Uses Imagick · ImagickDraw · ImagickDrawException · ImagickException · ImagickPixel · ImagickPixelException · Phalcon\Image\Enum · Phalcon\Image\Exception · Phalcon\Image\Exceptions\CompositeFailed · Phalcon\Image\Exceptions\ExtensionNotLoaded · Phalcon\Image\Exceptions\ImageLoadFailed · Phalcon\Image\Exceptions\ResizeFailed · Phalcon\Image\Exceptions\ResourceTypeError

Method Summary

Properties

Methods

__construct()

public function __construct(
    string $file,
    int $width = null,
    int $height = null
);

Constructor

__destruct()

public function __destruct();

Destroys the loaded image to free up resources.

liquidRescale()

public function liquidRescale(
    int $width,
    int $height,
    int $deltaX = 0,
    int $rigidity = 0
): AbstractAdapter;

This method scales the images using liquid rescaling method. Only support Imagick

setResourceLimit()

public function setResourceLimit(
    int $type,
    int $limit
): void;

Sets the limit for a particular resource in megabytes

@link https://www.php.net/manual/en/imagick.constants.php#imagick.constants.resourcetypes

processBackground()

protected function processBackground(
    int $red,
    int $green,
    int $blue,
    int $opacity
): void;

Execute a background.

processBlur()

protected function processBlur( int $radius ): void;

Blur image

processCrop()

protected function processCrop(
    int $width,
    int $height,
    int $offsetX,
    int $offsetY
): void;

Execute a crop.

processFlip()

protected function processFlip( int $direction ): void;

Execute a flip.

processMask()

protected function processMask( AdapterInterface $image ): void;

Composite one image onto another

processPixelate()

protected function processPixelate( int $amount ): void;

Pixelate image

processReflection()

protected function processReflection(
    int $height,
    int $opacity,
    bool $fadeIn
): void;

Execute a reflection.

processRender()

protected function processRender(
    string $extension,
    int $quality
): string;

Execute a render.

processResize()

protected function processResize(
    int $width,
    int $height
): void;

Execute a resize.

processRotate()

protected function processRotate( int $degrees ): void;

Execute a rotation.

processSave()

protected function processSave(
    string $file,
    int $quality
): void;

Execute a save.

processSharpen()

protected function processSharpen( int $amount ): void;

Execute a sharpen.

processText()

protected function processText(
    string $text,
    mixed $offsetX,
    mixed $offsetY,
    int $opacity,
    int $red,
    int $green,
    int $blue,
    int $size,
    string $fontFile = null
): void;

Execute a text

processWatermark()

protected function processWatermark(
    AdapterInterface $image,
    int $offsetX,
    int $offsetY,
    int $opacity
): void;

Add Watermark

Image\Enum

This file is part of the Phalcon Framework.

(c) Phalcon Team <[email protected]>

For the full copyright and license information, please view the LICENSE.txt file that was distributed with this source code.

Constants

Image\Exception

Exceptions thrown in Phalcon\Image will use this class

Image\Exceptions\CompositeFailed

This file is part of the Phalcon Framework.

(c) Phalcon Team <[email protected]>

For the full copyright and license information, please view the LICENSE.txt file that was distributed with this source code.

Uses Phalcon\Image\Exception

Method Summary

Methods

__construct()

public function __construct();

Image\Exceptions\ExtensionNotLoaded

This file is part of the Phalcon Framework.

(c) Phalcon Team <[email protected]>

For the full copyright and license information, please view the LICENSE.txt file that was distributed with this source code.

Uses Phalcon\Image\Exception

Method Summary

Methods

__construct()

public function __construct( string $extension );

Image\Exceptions\ImageLoadFailed

This file is part of the Phalcon Framework.

(c) Phalcon Team <[email protected]>

For the full copyright and license information, please view the LICENSE.txt file that was distributed with this source code.

Uses Phalcon\Image\Exception

Method Summary

Methods

__construct()

public function __construct( string $file );

Image\Exceptions\MissingDimensions

This file is part of the Phalcon Framework.

(c) Phalcon Team <[email protected]>

For the full copyright and license information, please view the LICENSE.txt file that was distributed with this source code.

Uses Phalcon\Image\Exception

Method Summary

Methods

__construct()

public function __construct();

Image\Exceptions\MissingHeight

This file is part of the Phalcon Framework.

(c) Phalcon Team <[email protected]>

For the full copyright and license information, please view the LICENSE.txt file that was distributed with this source code.

Uses Phalcon\Image\Exception

Method Summary

Methods

__construct()

public function __construct();

Image\Exceptions\MissingWidth

This file is part of the Phalcon Framework.

(c) Phalcon Team <[email protected]>

For the full copyright and license information, please view the LICENSE.txt file that was distributed with this source code.

Uses Phalcon\Image\Exception

Method Summary

Methods

__construct()

public function __construct();

Image\Exceptions\ResizeFailed

This file is part of the Phalcon Framework.

(c) Phalcon Team <[email protected]>

For the full copyright and license information, please view the LICENSE.txt file that was distributed with this source code.

Uses Phalcon\Image\Exception

Method Summary

Methods

__construct()

public function __construct();

Image\Exceptions\ResourceTypeError

This file is part of the Phalcon Framework.

(c) Phalcon Team <[email protected]>

For the full copyright and license information, please view the LICENSE.txt file that was distributed with this source code.

Uses Phalcon\Image\Exception

Method Summary

Methods

__construct()

public function __construct();

Image\Exceptions\TextRenderingFailed

This file is part of the Phalcon Framework.

(c) Phalcon Team <[email protected]>

For the full copyright and license information, please view the LICENSE.txt file that was distributed with this source code.

Uses Phalcon\Image\Exception

Method Summary

Methods

__construct()

public function __construct();

Image\Exceptions\UnsupportedImageType

This file is part of the Phalcon Framework.

(c) Phalcon Team <[email protected]>

For the full copyright and license information, please view the LICENSE.txt file that was distributed with this source code.

Uses Phalcon\Image\Exception

Method Summary

Methods

__construct()

public function __construct( string $format = "" );

Image\Exceptions\VersionMismatch

This file is part of the Phalcon Framework.

(c) Phalcon Team <[email protected]>

For the full copyright and license information, please view the LICENSE.txt file that was distributed with this source code.

Uses Phalcon\Image\Exception

Method Summary

Methods

__construct()

public function __construct( string $version );

Image\ImageFactory

Factory to create adapters for image manipulation

Uses Phalcon\Config\ConfigInterface · Phalcon\Factory\AbstractFactory · Phalcon\Image\Adapter\AdapterInterface

Method Summary

Methods

__construct()

public function __construct( array $services = [] );

Constructor

load()

public function load( mixed $config ): AdapterInterface;

Factory to create an instance from a Config object

newInstance()

public function newInstance(
    string $name,
    string $file,
    int $width = null,
    int $height = null
): AdapterInterface;

Creates a new instance

getExceptionClass()

protected function getExceptionClass(): string;

getServices()

protected function getServices(): array;

Returns the available adapters