| Fully Qualified Name: | Laminas\Hydrator\Aggregate\ExtractEvent |
| Extends: | Event |
Event triggered when the {@see AggregateHydrator} extracts data from an object
| Name | Description | Defined By |
|---|---|---|
| __construct() | ExtractEvent | |
| getExtractedData() | Retrieves the data that has been extracted | ExtractEvent |
| getExtractionObject() | Retrieves the object from which data is extracted | ExtractEvent |
| getName() | Get event name | Event |
| getParam() | Get an individual parameter | Event |
| getParams() | Get all parameters | Event |
| getTarget() | Get the event target | Event |
| mergeExtractedData() | Merge provided data with the extracted data | ExtractEvent |
| propagationIsStopped() | Is propagation stopped? | Event |
| setExtractedData() | ExtractEvent | |
| setExtractionObject() | ExtractEvent | |
| setName() | Set the event name | Event |
| setParam() | Set an individual parameter to a value | Event |
| setParams() | Set parameters | Event |
| setTarget() | Set the event target/context | Event |
| stopPropagation() | Stop further event propagation | Event |
| Parameter Name | Type | Description |
|---|---|---|
| $target | ||
| $extractionObject |
Returns: void
Retrieves the data that has been extracted
Returns: array
Retrieves the object from which data is extracted
Returns:
Get event name
Returns: string
Get an individual parameter
If the parameter does not exist, the $default value will be returned.
| Parameter Name | Type | Description |
|---|---|---|
| $name | string|int | |
| $default | mixed |
Returns: mixed
Get all parameters
Returns: array|object|\ArrayAccess
Get the event target
This may be either an object, or the name of a static method.
Returns: string|object
Merge provided data with the extracted data
| Parameter Name | Type | Description |
|---|---|---|
| $additionalData | array |
Returns:
Is propagation stopped?
Returns: bool
| Parameter Name | Type | Description |
|---|---|---|
| $extractedData | array |
Returns:
| Parameter Name | Type | Description |
|---|---|---|
| $extractionObject |
Returns: void
Set the event name
| Parameter Name | Type | Description |
|---|---|---|
| $name | string |
Returns:
Set an individual parameter to a value
| Parameter Name | Type | Description |
|---|---|---|
| $name | string|int | |
| $value | mixed |
Returns:
Set parameters
Overwrites parameters
| Parameter Name | Type | Description |
|---|---|---|
| $params | array|\ArrayAccess|object |
Returns:
Set the event target/context
| Parameter Name | Type | Description |
|---|---|---|
| $target | null|string|object |
Returns:
Stop further event propagation
| Parameter Name | Type | Description |
|---|---|---|
| $flag | bool |
Returns: