__construct()
debug()
dispatch()
export()
finalize()
getContents()
initialize()
log()
setIncludeSource()
$event_dispatcher
$include_source
$parser
Class responsible for writing the results of the Reflection of a single source file to disk.
| category | phpDocumentor |
|---|---|
| package | Parser\Exporter |
| author | Mike van Riel |
| license | MIT |
| link | http://phpdoc.org |
__construct(phpDocumentor_Parser $parser)
\phpDocumentor_Parser
debug(string $message) : void
| inherited_from | \phpDocumentor_Parser_Abstract::debug() |
|---|
stringThe message to log.
dispatch(string $name, \string[] $arguments) : mixed | null
This method tries to dispatch an event; if no Event Dispatcher has been set than this method will explicitly not fail and return null. By not failing we make the Event Dispatcher optional and is it easier for people to re-use this component in their own application.
| inherited_from | \phpDocumentor_Parser_Abstract::dispatch() |
|---|
stringName of the event to dispatch.
\string[]Arguments for this event.
\phpDocumentor_Parser_Exception |
if there is a dispatcher but it is not of type sfEventDispatcher |
|---|
mixednull
export(phpDocumentor_Reflection_File $file) : void
finalize() : void
getContents() : string | null
stringnull
initialize() : void
log(string $message, int $priority) : void
| inherited_from | \phpDocumentor_Parser_Abstract::log() |
|---|
stringThe message to log.
intThe logging priority, the lower, the more important. Ranges from 1 to 7
setIncludeSource(boolean $include_source)
boolean
$event_dispatcher : \sfEventDispatcher | null
| inherited_from | \phpDocumentor_Parser_Abstract::$$event_dispatcher |
|---|
$include_source : bool