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.

package Default
inherited_from \Zend\EventManager\Event

 Methods

Constructor

__construct(object $target, object $extractionObject) 

Accept a target and its parameters.

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

Parameters

$target

object

$extractionObject

object

Constructor

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

Accept a target and its parameters.

Parameters

$name

string

Event name

$target

stringobject

$params

array\ArrayAccess

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\EventInterface::getName()

Returns

string

Get an individual parameter

getParam(string|integer $name, mixed $default = null) : mixed
Inherited

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

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

Parameters

$name

stringinteger

$default

mixed

Returns

mixed

Get all parameters

getParams() : array | object | \ArrayAccess
Inherited
inherited_from \Zend\EventManager\EventInterface::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\EventInterface::getTarget()

Returns

stringobject

Merge provided data with the extracted data

mergeExtractedData(array $additionalData) : void

Parameters

$additionalData

array

Is propagation stopped?

propagationIsStopped() : boolean
Inherited
inherited_from \Zend\EventManager\EventInterface::propagationIsStopped()

Returns

boolean

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\EventInterface::setName()

Parameters

$name

string

Returns

\Zend\EventManager\Event

Set an individual parameter to a value

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

Parameters

$name

stringinteger

$value

mixed

Returns

\Zend\EventManager\Event

Set parameters

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

Overwrites parameters

inherited_from \Zend\EventManager\EventInterface::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\EventInterface::setTarget()

Parameters

$target

nullstringobject

Returns

\Zend\EventManager\Event

Stop further event propagation

stopPropagation(boolean $flag = true) : void
Inherited
inherited_from \Zend\EventManager\EventInterface::stopPropagation()

Parameters

$flag

boolean

 Properties

 

$extractedData

$extractedData : array

Default

array()
 

$extractionObject

$extractionObject : object

Default

 

$name

$name 

Default

self::EVENT_EXTRACT
inherited_from \Zend\EventManager\Event::name
 

Event name

$name : string

Default

 

The event parameters

$params : array | \ArrayAccess | object

Default

array()
 

Whether or not to stop propagation

$stopPropagation : boolean

Default

false
 

The event target

$target : string | object

Default

 Constants

 

EVENT_EXTRACT

EVENT_EXTRACT = 'extract'