Zend Framework
Back to top  

Custom event for use with module manager Composes Module objects

Encapsulates the target context and parameters passed, and provides some behavior for interacting with the event manager.

 Methods

Constructor

__construct(string $name, string | object $target, array | \ArrayAccess $params) 
Inherited

Accept a target and its parameters.

inherited_from \Zend\EventManager\Event::__construct()

Parameters

$name

string

Event name

$target

stringobject

$params

array\ArrayAccess

Get the config listener

getConfigListener() : null | \Zend\ModuleManager\Listener\ConfigMergerInterface

Returns

null\Zend\ModuleManager\Listener\ConfigMergerInterface

Get module object

getModule() : null | object

Returns

nullobject

Get the name of a given module

getModuleName() : string

Returns

string

Get event name

getName() : string
Inherited

inherited_from \Zend\EventManager\Event::getName()

Returns

string

Get an individual parameter

getParam(string | int $name, mixed $default) : mixed
Inherited

If the parameter does not exist, the $default value will be returned.

inherited_from \Zend\EventManager\Event::getParam()

Parameters

$name

stringint

$default

mixed

Returns

mixed

Get all parameters

getParams() : array | object | \ArrayAccess
Inherited

inherited_from \Zend\EventManager\Event::getParams()

Returns

arrayobject\ArrayAccess

Get the event target

getTarget() : string | object
Inherited

This may be either an object, or the name of a static method.

inherited_from \Zend\EventManager\Event::getTarget()

Returns

stringobject

Is propagation stopped?

propagationIsStopped() : bool
Inherited

inherited_from \Zend\EventManager\Event::propagationIsStopped()

Returns

bool

Set module object to compose in this event

setConfigListener(\Zend\ModuleManager\Listener\ConfigMergerInterface $configListener) : \Zend\ModuleManager\ModuleEvent

Parameters

$configListener

\Zend\ModuleManager\Listener\ConfigMergerInterface

Returns

\Zend\ModuleManager\ModuleEvent

Set module object to compose in this event

setModule(object $module) : \Zend\ModuleManager\ModuleEvent

Parameters

$module

object

Exceptions

\Zend\ModuleManager\Exception\InvalidArgumentException

Returns

\Zend\ModuleManager\ModuleEvent

Set the name of a given module

setModuleName(string $moduleName) : \Zend\ModuleManager\ModuleEvent

Parameters

$moduleName

string

Exceptions

\Zend\ModuleManager\Exception\InvalidArgumentException

Returns

\Zend\ModuleManager\ModuleEvent

Set the event name

setName(string $name) : \Zend\EventManager\Event
Inherited

inherited_from \Zend\EventManager\Event::setName()

Parameters

$name

string

Returns

\Zend\EventManager\Event

Set an individual parameter to a value

setParam(string | int $name, mixed $value) : \Zend\EventManager\Event
Inherited

inherited_from \Zend\EventManager\Event::setParam()

Parameters

$name

stringint

$value

mixed

Returns

\Zend\EventManager\Event

Set parameters

setParams(array | \ArrayAccess | object $params) : \Zend\EventManager\Event
Inherited

Overwrites parameters

inherited_from \Zend\EventManager\Event::setParams()

Parameters

$params

array\ArrayAccessobject

Exceptions

\Zend\EventManager\Exception\InvalidArgumentException

Returns

\Zend\EventManager\Event

Set the event target/context

setTarget(null | string | object $target) : \Zend\EventManager\Event
Inherited

inherited_from \Zend\EventManager\Event::setTarget()

Parameters

$target

nullstringobject

Returns

\Zend\EventManager\Event

Stop further event propagation

stopPropagation(bool $flag) : void
Inherited

inherited_from \Zend\EventManager\Event::stopPropagation()

Parameters

$flag

bool

 Properties

 

$configListener

$configListener : \Zend\ModuleManager\Listener\ConfigMergerInterface

 

$module

$module : mixed

 

$moduleName

$moduleName : string

 

<p>Event name</p>

$name : string
Inherited

inherited_from \Zend\EventManager\Event::$$name
 

<p>The event parameters</p>

$params : array | \ArrayAccess | object
Inherited

inherited_from \Zend\EventManager\Event::$$params
 

<p>Whether or not to stop propagation</p>

$stopPropagation : bool
Inherited

inherited_from \Zend\EventManager\Event::$$stopPropagation
 

<p>The event target</p>

$target : string | object
Inherited

inherited_from \Zend\EventManager\Event::$$target

 Constants

 

EVENT_LOAD_MODULE

EVENT_LOAD_MODULE 

 

EVENT_LOAD_MODULES

EVENT_LOAD_MODULES 

 

EVENT_LOAD_MODULES_POST

EVENT_LOAD_MODULES_POST 

 

EVENT_LOAD_MODULE_RESOLVE

EVENT_LOAD_MODULE_RESOLVE 

 

Module events triggered by eventmanager

EVENT_MERGE_CONFIG