Class SimpleID\Util\Events\OrderedDataCollectionEvent

`extends`	`BaseDataCollectionEvent`

A generic event used to collect data with a specified order.

Unlike the BaseDataCollectionEvent , results are always appended to the results array and never merged.

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

Located at core/Util/Events/OrderedDataCollectionEvent.php

Methods


					
	public

__construct(string $eventName = null)

Creates an ordered data collection event

$eventName

the name of the event, or null to use the name of this class


					
	public

addResult(array<mixed> $result, int $weight = 0): void

Adds data to the event with a specified weight. The weight is used to order the results, to be retrieved by OrderedDataCollectionEvent::getResults() .

`$result`	the data to add
`$weight`	the weight


					
	public

getResults(): array<mixed>

Retrieves the data collected from the event, ordered by the weight, from lowest to highest.

Methods inherited from SimpleID\Util\Events\BaseDataCollectionEvent
`hasResults(), isEmpty()`

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

Constants inherited from SimpleID\Util\Events\BaseDataCollectionEvent
`MERGE_DEFAULT, MERGE_APPEND, MERGE_PLAIN, MERGE_RECURSIVE, MERGE_MERGE`

Properties inherited from SimpleID\Util\Events\BaseDataCollectionEvent
`$results, $mergeStrategy`

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