- Symphony 2.7.6
-
› assets
14 -
› boot
15 -
› core
24 -
› cryptography
4 -
› data-sources
6 -
› email-gateways
3 -
› events
3 -
› global
61 -
› interface
9 -
› toolkit
60 - Delegates101
- Deprecated28
Versions
- 2.7.9
- 2.7.8
- 2.7.7
- 2.7.6
- 2.7.5
- 2.7.3
- 2.7.2
- 2.7.10
- 2.7.1
- 2.7.0
- 2.6.9
- 2.6.8
- 2.6.7
- 2.6.6
- 2.6.5
- 2.6.4
- 2.6.3
- 2.6.2
- 2.6.11
- 2.6.10
- 2.6.1
- 2.6.0
- 2.5.3
- 2.5.2
- 2.5.1
- 2.5.0
- 2.4
- 2.3.6
- 2.3.5
- 2.3.4
- 2.3.3
- 2.3.2
- 2.3.1
- 2.3
- 2.2.5
- 2.2.4
- 2.2.3
- 2.2.2
- 2.2.1
- 2.2
Options
public interface iEvent
interface.event.php #12This interface describes the minimum a new Event type needs to provide to be able to be used by Symphony
Methods
static array about()
Return an associative array of meta information about this event such creation date, who created it and the name.
static buildEditor(XMLElement $wrapper, $errors, $handle, $settings)
This function is invoked by the Event Editor and allows this event to provide HTML so that it can be created or edited. It is expected that this function will also handle the display of error messages.
Parameters
See Also
XMLElement execute()
This function actually executes the event, and returns the result of the
event as an XMLElement
so that the FrontendPage
class can add to
a page's XML.
Returns
This event should return an XMLElement
object.
static string getName()
Returns the human readable name of this event type. This is displayed in the event selection options.
static string getSource()
Returns the __CLASS__
on the provided event, this is often
used as a way to namespace settings in forms and provide a unique
handle for this event type
static string getTemplate()
Returns the absolute path to the template that this template will
use to save instances of this event in the events
folder.
mixed load()
The load functions determines whether an event will be executed or not
by comparing the Event's action with the $_POST
data. This function will
be called every time a page is loaded that an event is attached too. If the
action does exist, it typically calls the __trigger()
method, otherwise void.
Returns
XMLElement with the event result or void if the action did not match
static string prepare(
$fields, $parameters, $template)
Given the settings and any existing event parameters, return the contents of this event that can be saved to the filesystem.
Parameters
Returns
The completed template, ready to be saved.
array settings()
This function returns all the settings of the current event instance.
Returns
An associative array of settings for this event where the key is getClass
and the value is an associative array of settings, key being the setting name, value being, the value
static boolean validate(
$settings, $errors)
Given an array of settings, validate them, adding any errors
to the $errors
variable which is passed by reference. $errors
should be formatted as an associative array
Parameters
Returns
true if the event is valid, false otherwise. If false it is expected that $errors
are populated.