PreFileEvent

Extends \phpDocumentor\Event\EventAbstract

Event thrown before the parsing of an individual file.

package

Default

Methods

Initializes this event with the given subject.

__construct(object $subject) 
inherited

Arguments

$subject

object

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

createInstance(object $subject) : static
inherited static

Used as convenience method for fluent interfaces.

Arguments

$subject

object

Response

static

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

getFile() : string

Response

string

Returns the object that is the subject of this event.

getSubject() : object
inherited

Response

object

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

setFile(string $file) : self|\phpDocumentor\Parser\Event\PreFileEvent

Arguments

$file

string

Response

self|\phpDocumentor\Parser\Event\PreFileEvent

Properties

file

file : string
var

Type(s)

string

Represents an object that is the subject of this event

subject : object
inherited
var

Represents an object that is the subject of this event

Type(s)

object