Zend Framework  3.0
Public Member Functions | Public Attributes | Protected Attributes | List of all members
ModuleEvent Class Reference

Custom event for use with module manager Composes Module objects. More...

Public Member Functions

 getModuleName ()
 Get the name of a given module.
 
 setModuleName ($moduleName)
 Set the name of a given module.
 
 getModule ()
 Get module object.
 
 setModule ($module)
 Set module object to compose in this event.
 
 getConfigListener ()
 Get the config listener.
 
 setConfigListener (Listener\ConfigMergerInterface $configListener)
 Set module object to compose in this event.
 
- Public Member Functions inherited from Event
 __construct ($name=null, $target=null, $params=null)
 Constructor.
 
 getName ()
 Get event name.
 
 getTarget ()
 Get the event target.
 
 setParams ($params)
 Set parameters.
 
 getParams ()
 Get all parameters.
 
 getParam ($name, $default=null)
 Get an individual parameter.
 
 setName ($name)
 Set the event name.
 
 setTarget ($target)
 Set the event target/context.
 
 setParam ($name, $value)
 Set an individual parameter to a value.
 
 stopPropagation ($flag=true)
 Stop further event propagation.
 
 propagationIsStopped ()
 Is propagation stopped?
 

Public Attributes

const EVENT_MERGE_CONFIG = 'mergeConfig'
 Module events triggered by eventmanager.
 
const EVENT_LOAD_MODULES = 'loadModules'
 
const EVENT_LOAD_MODULE_RESOLVE = 'loadModule.resolve'
 
const EVENT_LOAD_MODULE = 'loadModule'
 
const EVENT_LOAD_MODULES_POST = 'loadModules.post'
 

Protected Attributes

 $module
 
 $moduleName
 
 $configListener
 
- Protected Attributes inherited from Event
 $name
 
 $target
 
 $params = []
 
 $stopPropagation = false
 

Detailed Description

Custom event for use with module manager Composes Module objects.

ModuleManager getTarget

Member Function Documentation

getConfigListener ( )

Get the config listener.

Returns
null|Listener
getModule ( )

Get module object.

Returns
null|object
getModuleName ( )

Get the name of a given module.

Returns
string
setConfigListener ( Listener\ConfigMergerInterface  $configListener)

Set module object to compose in this event.

Parameters
Listener\ConfigMergerInterface$configListener
Returns
ModuleEvent
setModule (   $module)

Set module object to compose in this event.

Parameters
object$module
Exceptions
Exception\InvalidArgumentException
Returns
ModuleEvent
setModuleName (   $moduleName)

Set the name of a given module.

Parameters
string$moduleName
Exceptions
Exception\InvalidArgumentException
Returns
ModuleEvent

Member Data Documentation

$configListener
protected
$module
protected
$moduleName
protected
const EVENT_LOAD_MODULE = 'loadModule'
const EVENT_LOAD_MODULE_RESOLVE = 'loadModule.resolve'
const EVENT_LOAD_MODULES = 'loadModules'
const EVENT_LOAD_MODULES_POST = 'loadModules.post'
const EVENT_MERGE_CONFIG = 'mergeConfig'

Module events triggered by eventmanager.