PreFileEvent
extends EventAbstract
in package
Event thrown before the parsing of an individual file.
Table of Contents
Properties
Methods
- __construct() : mixed
- Initializes this event with the given subject.
- createInstance() : self
- Creates a new instance of a derived object and return that.
- getFile() : string
- Returns the name of the file that is about to be processed.
- getSubject() : object
- Returns the object that is the subject of this event.
- isPropagationStopped() : bool
- Is propagation stopped?
- setFile() : self
- Sets the name of the file that is about to be processed.
- 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
$file
private
string
$file
= ''
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) : self
Used as convenience method for fluent interfaces.
Parameters
- $subject : object
Return values
selfgetFile()
Returns the name of the file that is about to be processed.
public
getFile() : string
Return values
stringgetSubject()
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.
setFile()
Sets the name of the file that is about to be processed.
public
setFile(string $file) : self
Parameters
- $file : string
Return values
selfstopPropagation()
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().