EventAbstract
extends Event
in package
Abstract class representing the base elements of a phpDocumentor event.
Table of Contents
- $subject : object
- $propagationStopped : mixed
- __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
$propagationStopped
private
mixed
$propagationStopped
= false
Methods
__construct()
Initializes this event with the given subject.
public
__construct(object $subject) : mixed
Parameters
- $subject : object
Return values
mixed —createInstance()
public
abstract static createInstance(object $subject) : self
Parameters
- $subject : object
Return values
self —getSubject()
Returns the object that is the subject of this event.
public
getSubject() : object
Return values
object —isPropagationStopped()
Is propagation stopped?
public
isPropagationStopped() : bool
Return values
bool —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().