API Documentation
\

\Horde_Image_Effect_Border

Image border decorator for the Horde_Image package.

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
No private methods found
No private properties found
N/A

Properties

$_params

$_params : array

Valid parameters for border effects: - bordercolor: Border color. Defaults to black.

  • borderwidth: Border thickness, defaults to 1 pixel.
    • preserve: Preserves the alpha transparency layer (if present)

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()

Draws the border.

This draws the configured border to the provided image. Beware, that every pixel inside the border clipping will be overwritten with the background color.