\Horde_Image_Effect_Im_PhotoStack

Effect for composing multiple images into a single image.

The technique for the Polaroid-like stack using the Imagick extension is credited to Mikko Koppanen and is documented at http://valokuva.org

Summary

Methods
Properties
Constants
__construct()
setImageObject()
setLogger()
factory()
apply()
No public properties found
No constants found
No protected methods found
$_params
$_image
$_logger
N/A
_roundBorder()
No private properties found
N/A

Properties

$_params

$_params : array

Valid parameters for the stack effect: - images: (array) An array of Horde_Image objects to stack. Images are stacked in a FIFO manner, so that the top-most image is the last one in this array.

  • type: (string) Determines the style for the composition. 'plain' or 'polaroid' are supported.
    • resize_height: (integer) The height that each individual thumbnail should be resized to before composing on the image.
    • padding: (integer) How much padding should we ensure is left around the active image area?
    • background: (string) The background canvas color - this is used as the color to set any padding to.
    • bordercolor: (string) If using type 'plain' this sets the color of the border that each individual thumbnail gets.
    • borderwidth: (integer) If using type 'plain' this sets the width of the border on each individual thumbnail.
    • offset: (integer) If using type 'plain' this determines the amount of x and y offset to give each successive image when it is placed on the top of the stack.

Type

array

$_image

$_image : \Horde_Image

The bound Horde_Image object

Type

\Horde_Image

$_logger

$_logger : 

Logger.

Type

Methods

__construct()

__construct(array  $params = array()) 

Effect constructor.

Parameters

array $params

Any parameters for the effect. Parameters are documented in each subclass.

setImageObject()

setImageObject(\Horde_Image  $image) 

Bind this effect to a Horde_Image object.

Parameters

\Horde_Image $image

The Horde_Image object

setLogger()

setLogger(\Horde_Log_Logger  $logger) 

Attaches a logger.

Parameters

\Horde_Log_Logger $logger

A logger.

factory()

factory(string  $type, string  $driver, array  $params) : \Horde_Image_Effect

Effect factory.

Parameters

string $type

An effect name.

string $driver

An image driver name.

array $params

Any effect parameters.

Returns

\Horde_Image_Effect

An effect instance.

apply()

apply() 

Applies the effect.

_roundBorder()

_roundBorder(  $image) 

Parameters

$image