Documentation

PreParsingEvent extends EventAbstract
in package

Event thrown before the parsing all files.

Table of Contents

$subject  : object
$fileCount  : int
$propagationStopped  : mixed
__construct()  : mixed
Initializes this event with the given subject.
createInstance()  : EventAbstract
Creates a new instance of a derived object and return that.
getFileCount()  : int
getSubject()  : object
Returns the object that is the subject of this event.
isPropagationStopped()  : bool
Is propagation stopped?
setFileCount()  : self
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()

Creates a new instance of a derived object and return that.

public static createInstance(object $subject) : EventAbstract

Used as convenience method for fluent interfaces.

Parameters
$subject : object
Return values
EventAbstract

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

setFileCount()

public setFileCount(int $fileCount) : self
Parameters
$fileCount : int
Return values
self

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().

Return values
void

Search results