Jump to Content

Objective HTML

Photo Frame

Effects API

The Photo Frame Effects API is used to create your own effects which will appear in the effects window. This API requires that you have the Effects Pack installed, otherwise the effect you create won't be visible in the UI. These effects can be programmatically complex, but the UI only allows users to toggle them on or off. Compared to effecs created by buttons are configurable using UI controls.

Properties

$name
The name of the effect.
$description
The description of the effect.
$effect
The effect ID. This is usually the same as the name, unless the name has spaces or special characters. This value should be all lowercase.

Extends

BaseClass

Methods

install()

The install() method is triggered when Photo Frame is installed. Each API has an install routine that may be used to perform custom logic.

Return

(void)

update($version)

The update() method is triggered when Photo Frame is updated. Each API has an update routine that may be used to perform custom logic.

$version
This string is the Photo Frame version
Return

(void)

uninstall()

The uninstall() method is triggered when Photo Frame is uninstalled. Each API has an uninstall routine that may be used to perform custom logic.

Return

(void)

modifyTables()

The modifyTables() method allows your buttons to modify the database schema for Photo Frame before it is installed. This is usefull to add new columns to the exp_photo_frame table, or alter the existing ones.

Return

(void)

render($image = array())

The render() method is triggered when t has been created and is now attempted to be rendered.

$image
This object is the instantiated ImageEditor object used to manipulate the photo.
Return

(void)