Documentation

PreParsingEvent extends EventAbstract
in package

FinalYes

Event thrown before the parsing all files.

Table of Contents

Properties

$subject  : object
$fileCount  : int

Methods

__construct()  : mixed
Initializes this event with the given subject.
createInstance()  : PreParsingEvent
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

Methods

__construct()

Initializes this event with the given subject.

public __construct(object $subject) : mixed
Parameters
$subject : object

createInstance()

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

public static createInstance(object $subject) : PreParsingEvent

Used as convenience method for fluent interfaces.

Parameters
$subject : object
Return values
PreParsingEvent

getSubject()

Returns the object that is the subject of this event.

public getSubject() : object
Return values
object

isPropagationStopped()

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.

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


        
On this page

Search results