Create

MMO\core\events · 1 symbol · generated 30 Sep 2026

class

Create

Dispatched to build an instance of $class, letting a listener answer with $event->setReturn($instance) instead of a plain new $class(...) -- e.g. so a factory/DI mechanism can intercept construction.

class MMO\core\events\Create extends MMO\core\events\Signal implements MMO\core\interfaces\iStoppableEvent use MMO\core\classes\tStoppableEvent, MMO\core\classes\tWithOptions

Namespace: MMO\core\events
Extends: Signal
Implements: iStoppableEvent
Uses traits: tStoppableEvent, tWithOptions

Index

	class
	opts
	stopped
	addOptions($opts, $appendList)	Merge $opts into the existing options (through `merge`), rather than replacing them wholesale like `setOptions`.
	clearOptions()	Empty the options bag.
	getOption($key, $default)
	getOptions()
	isPropagationStopped()
	setOption($key, $value)	Set (or, with a null $value, remove) a single option.
	setOptions($opts)	Replace the whole options bag.
	stopPropagation()	Prevent any remaining listener in the current dispatch chain from being called.
	__clone()	A cloned event starts fresh: propagation is never considered stopped on the clone, even if it was on the original instance.
	__construct($origin, $class, $opts)

Properties3

class

string $class

Type: string

opts

protected array $opts = []

Type: array

stopped

protected $stopped = false

Methods10

addOptions($opts, $appendList)

tWithOptions.php:65

Merge $opts into the existing options (through merge), rather than replacing them wholesale like setOptions.

function addOptions(array $opts, bool $appendList = false): void

$opts	array	the options to merge in
$appendList = false	bool	if true, a list-valued option is appended to (rather than replaced by) the corresponding list in $opts -- see \MMO\core\arrays\merge for the exact semantics
returns	void

$t->setOptions(['a' => 1, 'tags' => ['x']]); $t->addOptions(['b' => 2, 'tags' => ['y']]); $t->getOptions(); // ['a' => 1, 'tags' => ['y'], 'b' => 2] -- 'tags' is replaced, not appended ($appendList=false)

clearOptions()

tWithOptions.php:39

Empty the options bag.

function clearOptions(): void

returns

void

$t->clearOptions(); // getOptions() === []

getOption($key, $default)

tWithOptions.php:49

function getOption(string $key, mixed $default = null): mixed

$key	string
$default = null	mixed	returned if $key is not set
returns	mixed

$t->getOption('a', 'fallback'); // the current value of 'a', or 'fallback' if not set

getOptions()

tWithOptions.php:20

function getOptions(): array

returns

array

every option currently set

$t->getOptions(); // ['a' => 1, 'tags' => ['x']]

isPropagationStopped()

tStoppableEvent.php:21

function isPropagationStopped(): bool

returns bool true once stopPropagation has been called on this instance

setOption($key, $value)

tWithOptions.php:77

Set (or, with a null $value, remove) a single option.

function setOption(string $key, mixed $value): void

$key	string
$value	mixed	if null, the option is unset entirely rather than being set to null
returns	void

$t->setOption('a', 1);

$t->setOption('a', null); // removes 'a' from getOptions()

setOptions($opts)

tWithOptions.php:30

Replace the whole options bag.

function setOptions(array $opts): void

$opts	array
returns	void

$t->setOptions(['a' => 1]);

stopPropagation()

tStoppableEvent.php:29

Prevent any remaining listener in the current dispatch chain from being called.

function stopPropagation()

returns

__clone()

tStoppableEvent.php:38

A cloned event starts fresh: propagation is never considered stopped on the clone, even if it was on the original instance.

function __clone()

returns

__construct($origin, $class, $opts)

Create.php:21

function __construct(object|string $origin, string $class, array $opts = [])

$origin	object \| string
$class	string	the class to build an instance of
$opts = []	array	constructor arguments/options

Inherited members (16)

	Properties	Declared by	Description
	`Listeners`	Event
	`origin`	Event
	`returnValue`	Signal

Methods	Declared by	Description
`AddListener($handler, $order)`	Event	Register a listener directly (as opposed to `ConnectListeners`'s attribute-based discovery).
`ConnectListeners($obj)`	Event	Scan $obj's methods for #[Listen(EventClass::class)] attributes and register each one as a listener on the matching event class.
`DisconnectListeners($obj)`	Event	Undo a previous `ConnectListeners`: removes every listener that `connect` had registered for $obj on this event class.
`dispatch()`	Event	Invoke every `GetListeners` listener with $this.
`GetListeners()`	Event	Collect every listener for this class, including those registered on its parent classes (so a subclass event is also caught by listeners of its parent event), sorted by ascending $order (ties keep …
`getOrigin()`	Event
`getReturn()`	Signal
`HasListener($handler)`	Event
`hasReturn()`	Signal
`RemoveListener($handler)`	Event	Remove the last added handler from the listeners.
`Send($args)`	Event	Construct a new instance of this class with $args, then `dispatch` it to every listener.
`SetListenerOrder($handler, $order)`	Event	Change the order of an already-registered listener, whether added directly via `AddListener` or indirectly via `ConnectListeners` (which also stores its `[$obj, $methodName]` callables here).
`setReturn($value, $stop)`	Signal