Horde_Image_Effect_Im_PhotoStack
extends Horde_Image_Effect
in package
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
Tags
Table of Contents
- $_image : Horde_Image
- The bound Horde_Image object
- $_logger : mixed
- Logger.
- $_params : array<string|int, mixed>
- 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.
- __construct() : mixed
- Effect constructor.
- apply() : mixed
- Applies the effect.
- factory() : Horde_Image_Effect
- Effect factory.
- setImageObject() : mixed
- Bind this effect to a Horde_Image object.
- setLogger() : mixed
- Attaches a logger.
- _roundBorder() : mixed
Properties
$_image
The bound Horde_Image object
protected
Horde_Image
$_image
= \null
$_logger
Logger.
protected
mixed
$_logger
$_params
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.
protected
array<string|int, mixed>
$_params
= array('type' => 'plain', 'resize_height' => '150', 'padding' => 0, 'background' => 'none', 'bordercolor' => '#333', 'borderwidth' => 1, 'borderrounding' => 10, 'offset' => 5)
- 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.
Methods
__construct()
Effect constructor.
public
__construct([array<string|int, mixed> $params = array() ]) : mixed
Parameters
- $params : array<string|int, mixed> = array()
-
Any parameters for the effect. Parameters are documented in each subclass.
Return values
mixed —apply()
Applies the effect.
public
apply() : mixed
Return values
mixed —factory()
Effect factory.
public
static factory(string $type, string $driver, array<string|int, mixed> $params) : Horde_Image_Effect
Parameters
- $type : string
-
An effect name.
- $driver : string
-
An image driver name.
- $params : array<string|int, mixed>
-
Any effect parameters.
Return values
Horde_Image_Effect —An effect instance.
setImageObject()
Bind this effect to a Horde_Image object.
public
setImageObject(Horde_Image $image) : mixed
Parameters
- $image : Horde_Image
-
The Horde_Image object
Return values
mixed —setLogger()
Attaches a logger.
public
setLogger(Horde_Log_Logger $logger) : mixed
Parameters
- $logger : Horde_Log_Logger
-
A logger.
Return values
mixed —_roundBorder()
private
_roundBorder(mixed $image) : mixed
Parameters
- $image : mixed