Class flEvent
flEvent Class
Base class for holding event data.
Package: fusionLib
Copyright:
Copyright (c) 2008 - 2013 fusionLib. All rights reserved.
Located at system/libs/Event/flEvent.php
Methods summary
public
|
#
__construct( string $name, array $params = array() )
Array of parameters to pass along with the event.
Array of parameters to pass along with the event.
Parameters
- $name
- The event name.
- $params
- Parameters.
|
public
string
|
#
getName( )
Get the name of the event.
Get the name of the event.
Returns
string The event name.
|
public
|
#
stopPropagation( )
Stop propagation of this event to other listeners.
Stop propagation of this event to other listeners.
|
public
boolean
|
#
isPropagationStopped( )
True if event propagation has been stopped.
True if event propagation has been stopped.
Returns
boolean true if stopped; else false.
|
public
array
|
#
getParams( )
Get the array of parameters for the event.
Get the array of parameters for the event.
Returns
array Event parameters.
|
public
mixed
|
#
getParam( string $name, string $default = null )
Get the value of a parameter.
Get the value of a parameter.
Parameters
- $name
- The name of the parameter to get.
- $default
- The default value to return.
Returns
mixed The parameter value or default if the parameter is not available.
|
public
|
#
setParam( string $name, mixed $value )
Set a new value for a parameter.
Set a new value for a parameter.
Parameters
- $name
- The name of the parameter to set.
- $value
- The value to set for the parameter.
|
Properties summary
protected
string
|
$name
|
|
protected
array
|
$params
Parameters to pass with the event.
Parameters to pass with the event.
|
|
protected
boolean
|
$propagationStopped
Flags if event propagation stopped.
Flags if event propagation stopped.
|
|