phpDocumentor

PreFileEvent extends EventAbstract
in package

Event thrown before the parsing of an individual file.

Table of Contents

$subject  : object
$file  : string
__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.
setFile()  : self
Sets the name of the file that is about to be processed.

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
Return values
mixed

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
self

getFile()

Returns the name of the file that is about to be processed.

public getFile() : string
Return values
string

getSubject()

Returns the object that is the subject of this event.

public getSubject() : object
Return values
object

setFile()

Sets the name of the file that is about to be processed.

public setFile(string $file) : self
Parameters
$file : string
Return values
self

Search results