\phpDocumentor\Parser\EventPreFileEvent

Event thrown before the parsing of an individual file.

Summary

Methods
Properties
Constants
__construct()
getSubject()
createInstance()
setFile()
getFile()
No public properties found
No constants found
No protected methods found
$subject
N/A
No private methods found
$file
N/A

Properties

$subject

$subject : object

Type

object — Represents an object that is the subject of this event

$file

$file : string

Type

string

Methods

__construct()

__construct(object  $subject) : mixed

Initializes this event with the given subject.

Parameters

object $subject

Returns

mixed —

getSubject()

getSubject() : object

Returns the object that is the subject of this event.

Returns

object —

createInstance()

createInstance(object  $subject) : self

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

Used as convenience method for fluent interfaces.

Parameters

object $subject

Returns

self —

setFile()

setFile(string  $file) : self

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

Parameters

string $file

Returns

self —

getFile()

getFile() : string

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

Returns

string —