1. class
  2. Composer
  3. \
  4. EventDispatcher
  5. \
  6. Event

Event

class Event (View source)

The base event class

Properties

protected string $name
protected array $args
protected array $flags

Methods

__construct(string $name, array $args = array(), array $flags = array())

Constructor.

string
getName()

Returns the event's name.

array
getArguments()

Returns the event's arguments.

array
getFlags()

Returns the event's flags.

bool
isPropagationStopped()

Checks if stopPropagation has been called

stopPropagation()

Prevents the event from being passed to further listeners

Details

at line 49
__construct(string $name, array $args = array(), array $flags = array())

Constructor.

Parameters

string $name The event name
array $args Arguments passed by the user
array $flags Optional flags to pass data not as argument

at line 61
string getName()

Returns the event's name.

Return Value

string The event name

at line 71
array getArguments()

Returns the event's arguments.

Return Value

array The event arguments

at line 81
array getFlags()

Returns the event's flags.

Return Value

array The event flags

at line 91
bool isPropagationStopped()

Checks if stopPropagation has been called

Return Value

bool Whether propagation has been stopped

at line 99
stopPropagation()

Prevents the event from being passed to further listeners