phpDocumentor
Back to top  

Class responsible for writing the results of the Reflection of a single source file to disk.

 Methods

Construct the object with the location where to write the structure file(s).

__construct(\phpDocumentor\Parser\Parser $parser) 

Parameters

$parser

\phpDocumentor\Parser\Parser

Dispatches a logging request to log a debug message.

debug(string $message) : void
Inherited
inherited_from \phpDocumentor\Parser\ParserAbstract::debug()

Parameters

$message

string

The message to log.

Renders the reflected file to a structure file.

export(\phpDocumentor\Reflection\FileReflector $file) : void

Parameters

$file

\phpDocumentor\Reflection\FileReflector

File to export.

Finalizes this exporter; performs cleaning operations.

finalize() : void

Returns the contents of this export or null if contents were directly written to disk.

getContents() : string | null

Returns

stringnull

Returns whether to include the source code in the resulting files.

getIncludeSource() : boolean

Returns

boolean

Initializes this exporter.

initialize() : void

Dispatches a logging request.

log(string $message, int $priority) : void
Inherited
inherited_from \phpDocumentor\Parser\ParserAbstract::log()

Parameters

$message

string

The message to log.

$priority

int

The logging priority, the lower,the more important. Ranges from 1 to 7

Sets whether to include the source in the structure files.

setIncludeSource(boolean $include_source) : void

Parameters

$include_source

boolean

 Properties

 

$include_source : bool
 

$parser : \phpDocumentor\Parser\Parser