API Documentation
\

\Horde_Image_Effect_Gd_TextWatermark

Image effect for watermarking images with text.

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 watermark effects: - text: [REQUIRED] (string) The text of the watermark.

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

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

Applies the effect.