Zend Framework
Back to top  

Representation of an event

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

contentSent() 

contentSent() : bool

Returns

bool

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

getResponse() 

getResponse() : \Zend\Stdlib\ResponseInterface

Returns

\Zend\Stdlib\ResponseInterface

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

headersSent() 

headersSent() : bool

Returns

bool

Is propagation stopped?

propagationIsStopped() : bool
Inherited

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

Returns

bool

Set content sent for current response

setContentSent() : \Zend\Mvc\ResponseSender\SendResponseEvent

Returns

\Zend\Mvc\ResponseSender\SendResponseEvent

Set headers sent for current response object

setHeadersSent() : \Zend\Mvc\ResponseSender\SendResponseEvent

Returns

\Zend\Mvc\ResponseSender\SendResponseEvent

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

setResponse() 

setResponse(\Zend\Stdlib\ResponseInterface $response) : \Zend\Mvc\ResponseSender\SendResponseEvent

Parameters

$response

\Zend\Stdlib\ResponseInterface

Returns

\Zend\Mvc\ResponseSender\SendResponseEvent

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

 

$contentSent

$contentSent : array

 

$headersSent

$headersSent : array

 

<p>Event name</p>

$name : string

 

<p>The event parameters</p>

$params : array | \ArrayAccess | object
Inherited

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

$response

$response : \Zend\Stdlib\ResponseInterface

 

<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_SEND_RESPONSE

EVENT_SEND_RESPONSE