Class EventObject

Event Object

Holds event data regarding a single event, and is passed between the dispatcher and the listener

Package: blesta\components\events
Copyright: Copyright (c) 2010, Phillips Data, Inc.
License: The Blesta License Agreement
Link: Blesta
Located at components/events/event_object.php

Methods summary

`public`	# `__construct( string $event_name, array $params = null )` Creates a new EventObject Creates a new EventObject Parameters `$event_name` `string` $event_name The name of the event `$params` `array` $params An array of parameters to be held by this event
`public string`	# `getName( )` Returns the name of this event Returns the name of this event Returns `string` The name of the event
`public array`	# `getParams( )` Returns the parameters set for this event Returns the parameters set for this event Returns `array` The parameters for the event
`public`	# `setParams( array $params = null )` Sets params for this event Sets params for this event Parameters `$params` `array` $params An array of parameters to be held by this event
`public mixed`	# `getReturnVal( )` Returns the return value set for this event Returns the return value set for this event Returns `mixed` The return value for the event
`public`	# `setReturnVal( mixed $return_val )` Sets the return value for this event Sets the return value for this event Parameters `$return_val` `mixed` $return_val The return value for the event

Magic methods summary

Properties summary

`protected string`	`$event_name`	# $event_name The name of the event $event_name The name of the event
`protected array`	`$params`	# $params An array of parameters held by this event $params An array of parameters held by this event
`protected mixed`	`$return_val`	# $return_val The return value (if any) from the event listener $return_val The return value (if any) from the event listener

Packages

Classes

Class EventObject

Methods summary

Parameters

Returns

Returns

Parameters

Returns

Parameters

Magic methods summary

Properties summary