Zend Framework
Back to top  

Event triggered when the {@see \Zend\Stdlib\Hydrator\Aggregate\AggregateHydrator} extracts data from an object

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

 Methods

Constructor

__construct(object $target, object $extractionObject) 

Accept a target and its parameters.

Parameters

$target

object

$extractionObject

object

Retrieves the data that has been extracted

getExtractedData() : array

Returns

array

Retrieves the object from which data is extracted

getExtractionObject() : object

Returns

object

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

Merge provided data with the extracted data

mergeExtractedData(array $additionalData) : void

Parameters

$additionalData

array

Is propagation stopped?

propagationIsStopped() : bool
Inherited

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

Returns

bool

setExtractedData() 

setExtractedData(array $extractedData) : void

Parameters

$extractedData

array

setExtractionObject() 

setExtractionObject(object $extractionObject) : void

Parameters

$extractionObject

object

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

 

$extractedData

$extractedData : array

 

$extractionObject

$extractionObject : object

 

<p>Event name</p>

$name : string

 

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

EVENT_EXTRACT