Documentation

Horde_Image_Effect_Border extends Horde_Image_Effect
in package

Image border decorator for the Horde_Image package.

Tags
author

Chuck Hagenbuch chuck@horde.org

category

Horde

copyright

2002-2017 Horde LLC

license

http://www.horde.org/licenses/lgpl21 LGPL-2.1

Table of Contents

$_image  : Horde_Image
The bound Horde_Image object
$_logger  : mixed
Logger.
$_params  : array<string|int, mixed>
Valid parameters for border effects: - bordercolor: Border color. Defaults to black.
__construct()  : mixed
Effect constructor.
apply()  : mixed
Draws the border.
factory()  : Horde_Image_Effect
Effect factory.
setImageObject()  : mixed
Bind this effect to a Horde_Image object.
setLogger()  : mixed
Attaches a logger.

Properties

$_logger

Logger.

protected mixed $_logger

$_params

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

protected array<string|int, mixed> $_params = array('bordercolor' => 'black', 'borderwidth' => 1, 'preserve' => \true)
  • borderwidth: Border thickness, defaults to 1 pixel.
  • preserve: Preserves the alpha transparency layer (if present)

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

Draws the border.

public apply() : mixed

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

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

Search results