Docs For Class modSystemEvent

Description

Represents a modEvent when invoking events.

Located in /model/modx/modx.class.php (line 2972)

Class Constant Summary

MODE_NEW = 'new'

MODE_UPD = 'upd'

Variable Summary

boolean $activated

mixed $activePlugin

string $name

array $params

mixed $propertySet

mixed $returnedValues

mixed $_output

boolean $_propagate

Method Summary

void alert (string $msg)

boolean isPropagatable ()

void output (string $output)

void resetEventObject ()

void stopPropagation ()

Variables

boolean $activated (line 2996)

access: public

mixed $activePlugin = '' (line 2986)

access: public

string $name = '' (line 2985)

deprecated: 2007-09-18 Will be delegated in 1.0 or sooner.
access: public

array $params (line 3004)

access: public

mixed $propertySet = '' (line 2987)

access: public

mixed $returnedValues (line 3000)

access: public

mixed $_output (line 2992)

access: public

boolean $_propagate = true (line 2991)

access: protected

Methods

alert (line 3015)

Display a message to the user during the event.

todo: Remove this; the centralized modRegistry will handle configurable logging of any kind of message or data to any repository or output context. Use modX::_log() in the meantime.
access: public

void alert (string $msg)

string $msg: The message to display.

isPropagatable (line 3038)

Returns whether the event will propagate or not.

access: public

boolean isPropagatable ()

output (line 3021)

Render output from the event.

access: public

void output (string $output)

string $output: The output to render.

resetEventObject (line 3045)

Reset the event instance for reuse.

access: public

void resetEventObject ()

stopPropagation (line 3028)

Stop further execution of plugins for this event.

access: public

void stopPropagation ()

Class Constants

MODE_NEW = 'new' (line 2976)

var: For new creations of objects in model events

MODE_UPD = 'upd' (line 2980)

var: For updating objects in model events