Horde_Image_Effect_Gd_Border
extends Horde_Image_Effect_Border
in package
Image border decorator for the Horde_Image package.
Tags
Table of Contents
- $_image : Horde_Image
- The bound Horde_Image object
- $_logger : mixed
- Logger.
- $_params : array<string|int, mixed>
- Effect parameters.
- __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
$_image
The bound Horde_Image object
protected
Horde_Image
$_image
= \null
$_logger
Logger.
protected
mixed
$_logger
$_params
Effect parameters.
protected
array<string|int, mixed>
$_params
= array()
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.