Horde_Image_Effect_Im_TextWatermark
extends Horde_Image_Effect
in package
Image effect for watermarking images with text.
Tags
Table of Contents
- $_image : Horde_Image
- The bound Horde_Image object
- $_logger : mixed
- Logger.
- $_params : array<string|int, mixed>
- Valid parameters for watermark effects: - text: [REQUIRED] (string) The text of the watermark.
- __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.
Properties
$_image
The bound Horde_Image object
protected
Horde_Image
$_image
= \null
$_logger
Logger.
protected
mixed
$_logger
$_params
Valid parameters for watermark effects: - text: [REQUIRED] (string) The text of the watermark.
protected
array<string|int, mixed>
$_params
= array('halign' => 'right', 'valign' => 'bottom', 'font' => 'courier', 'fontsize' => 'small')
- halign: (string) The horizontal placement
- valign: (string) The vertical placement
- font: (string) The font name or family to use
- fontsize: (string) The size of the font to use (small, medium, large, giant)
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.