EventManager/EventDescription.php
Show:
inherited
inheritedZend Framework
LICENSE
This source file is subject to the new BSD license that is bundled
with this package in the file LICENSE.txt.
It is also available through the world-wide-web at this URL:
http://framework.zend.com/license/new-bsd
If you did not receive a copy of the license and are unable to
obtain it through the world-wide-web, please send an email
to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_EventManager
\Zend_EventManager_EventDescription
Package: Zend_EventManager
Representation of an event
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Methods
getName() : stringGet event name
Returns
| Type | Description |
|---|---|
| string |
getParam(string $name, mixed $default = null) : mixedGet a single parameter by name
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | string | |
| $default | mixed | Default value to return if parameter does not exist |
| Type | Description |
|---|---|
| mixed |
getParams() : array | \ArrayAccessGet parameters passed to the event
Returns
| Type | Description |
|---|---|
| array | \ArrayAccess |
getTarget() : null | string | objectGet target/context from which event was triggered
Returns
| Type | Description |
|---|---|
| null | string | object |
propagationIsStopped() : boolHas this event indicated event propagation should stop?
Returns
| Type | Description |
|---|---|
| bool |
setName(string $name) : voidSet the event name
Parameters
| Name | Type | Description |
|---|---|---|
| $name | string |
setParam(string $name, mixed $value) : voidSet a single parameter by key
Parameters
| Name | Type | Description |
|---|---|---|
| $name | string | |
| $value | mixed |
setParams(string $params) : voidSet event parameters
Parameters
| Name | Type | Description |
|---|---|---|
| $params | string |
setTarget(null | string | object $target) : voidSet the event target/context
Parameters
| Name | Type | Description |
|---|---|---|
| $target | null | string | object |
stopPropagation(bool $flag = true) : voidIndicate whether or not the parent EventCollection should stop propagating events
Parameters
| Name | Type | Description |
|---|---|---|
| $flag | bool |