| Fully Qualified Name: | Laminas\ModuleManager\ModuleEvent |
| Extends: | Event |
Custom event for use with module manager Composes Module objects
| Name | Description | Defined By |
|---|---|---|
| __construct() | Constructor | Event |
| getConfigListener() | Get the config listener | ModuleEvent |
| getModule() | Get module object | ModuleEvent |
| getModuleName() | Get the name of a given module | ModuleEvent |
| getName() | Get event name | Event |
| getParam() | Get an individual parameter | Event |
| getParams() | Get all parameters | Event |
| getTarget() | Get the event target | Event |
| propagationIsStopped() | Is propagation stopped? | Event |
| setConfigListener() | Set module object to compose in this event | ModuleEvent |
| setModule() | Set module object to compose in this event | ModuleEvent |
| setModuleName() | Set the name of a given module | ModuleEvent |
| setName() | Set the event name | Event |
| setParam() | Set an individual parameter to a value | Event |
| setParams() | Set parameters | Event |
| setTarget() | Set the event target/context | Event |
| stopPropagation() | Stop further event propagation | Event |
Constructor
Accept a target and its parameters.
| Parameter Name | Type | Description |
|---|---|---|
| $name | string | Event |
| $target | string|object | |
| $params | array|\ArrayAccess |
Returns:
Get the config listener
Returns: null|\Listener\ConfigMergerInterface
Get module object
Returns: null|object
Get the name of a given module
Returns: string
Get event name
Returns: string
Get an individual parameter
If the parameter does not exist, the $default value will be returned.
| Parameter Name | Type | Description |
|---|---|---|
| $name | string|int | |
| $default | mixed |
Returns: mixed
Get all parameters
Returns: array|object|\ArrayAccess
Get the event target
This may be either an object, or the name of a static method.
Returns: string|object
Is propagation stopped?
Returns: bool
Set module object to compose in this event
| Parameter Name | Type | Description |
|---|---|---|
| $configListener | \Listener\ConfigMergerInterface |
Returns: \ModuleEvent
Set module object to compose in this event
| Parameter Name | Type | Description |
|---|---|---|
| $module | object |
Returns: \ModuleEvent
Set the name of a given module
| Parameter Name | Type | Description |
|---|---|---|
| $moduleName | string |
Returns: \ModuleEvent
Set the event name
| Parameter Name | Type | Description |
|---|---|---|
| $name | string |
Returns:
Set an individual parameter to a value
| Parameter Name | Type | Description |
|---|---|---|
| $name | string|int | |
| $value | mixed |
Returns:
Set parameters
Overwrites parameters
| Parameter Name | Type | Description |
|---|---|---|
| $params | array|\ArrayAccess|object |
Returns:
Set the event target/context
| Parameter Name | Type | Description |
|---|---|---|
| $target | null|string|object |
Returns:
Stop further event propagation
| Parameter Name | Type | Description |
|---|---|---|
| $flag | bool |
Returns: