Class SimpleID\Util\Events\BaseDataCollectionEvent

`extends`	`BaseEvent`
`implements`	`GenericEventInterface`
`uses`	`GenericEventTrait`

A generic event used to collect data.

This class implements f3-event-dispatcher's GenericEventInterface, and therefore the event name is specified by the $eventName parameter passed in the constructor.

Listeners add data by calling the addResult() method. How this is added to the existing data depends on the merge strategy:

If the merge strategy is MERGE_APPEND, then the result is appended to the existing data
If the merge strategy is MERGE_PLAIN, then the result is merged to the existing data using array_merge
If the merge strategy is MERGE_RECURSIVE, then the result is merged to the existing data using array_merge_recursive
If the merge strategy is MERGE_DEFAULT, then the result is appended if it is a scalar, or merged if it is an array

The emitter can retrieve the collected data by calling the getResults() method.

SimpleID\Util\Events\BaseEvent
- SimpleID\Util\Events\BaseDataCollectionEvent implements GenericEventInterface uses GenericEventTrait
  - SimpleID\Protocols\Connect\ConnectBuildClaimsEvent
  - SimpleID\Util\Events\OrderedDataCollectionEvent

Located at core/Util/Events/BaseDataCollectionEvent.php

Methods


					
	public

__construct(string $eventName = null, int $mergeStrategy = self::MERGE_DEFAULT)

Creates a data collection event

Parameters

`$eventName`	the name of the event, or the null to use the name of this class
`$mergeStrategy`	whether the merge will be mergeStrategy

Overridden by


					
	public

addResult(mixed $result): void

Adds data to the event.

If the data to be added is an array, it is merged with the existing data. If the data to be added is a scalar, it is appended to the existing data.

Parameters

$result

the data to add

Overridden by

SimpleID\Util\Events\OrderedDataCollectionEvent::addResult()


					
	public

getResults(): array<mixed>

Retrieves the data collected from the event.

If no data is collected, an empty array is returned.

Overridden by

SimpleID\Util\Events\OrderedDataCollectionEvent::getResults()


					
	public

hasResults(): bool

Returns whether any data have been collected by the event.

Returns

true if data have been collected


					
	protected

isEmpty(mixed $x): bool

Returns whether a variable is "empty".

A variable is empty if it is null or is a zero-length array.

Parameters

`$x`	the variable

Returns

true if the variable is empty

Methods used from SimpleID\Util\Events\GenericEventTrait
`setEventName(), getEventName()`

Constants
`public`	`MERGE_DEFAULT = 0`	#
`public`	`MERGE_APPEND = 1`	#
`public`	`MERGE_PLAIN = 2`	#
`public`	`MERGE_RECURSIVE = 3`	#
`public`	`MERGE_MERGE = self::MERGE_PLAIN`	#

Properties
`protected`	`array<mixed>`	`$results = []`	#
`protected`	`int`	`$mergeStrategy`	#

Properties used from SimpleID\Util\Events\GenericEventTrait
`$eventName`

Namespaces

Classes

Traits

Class SimpleID\Util\Events\BaseDataCollectionEvent

Parameters

Overridden by

Parameters

Overridden by

Overridden by

Returns

Parameters

Returns