EventAbstract
extends Event
in package
AbstractYes
Abstract class representing the base elements of a phpDocumentor event.
Table of Contents
Properties
- $subject : object
Methods
- __construct() : mixed
- Initializes this event with the given subject.
- createInstance() : self
- getSubject() : object
- Returns the object that is the subject of this event.
- isPropagationStopped() : bool
- Is propagation stopped?
- stopPropagation() : void
- Stops the propagation of the event to further event listeners.
Properties
$subject
protected
object
$subject
Represents an object that is the subject of this event
Methods
__construct()
Initializes this event with the given subject.
public
__construct(object $subject) : mixed
Parameters
- $subject : object
createInstance()
public
abstract static createInstance(object $subject) : self
Parameters
- $subject : object
Return values
selfgetSubject()
Returns the object that is the subject of this event.
public
getSubject() : object
Return values
objectisPropagationStopped()
Is propagation stopped?
public
isPropagationStopped() : bool
This will typically only be used by the Dispatcher to determine if the previous listener halted propagation.
Return values
bool —True if the Event is complete and no further listeners should be called. False to continue calling listeners.
stopPropagation()
Stops the propagation of the event to further event listeners.
public
stopPropagation() : void
If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().