Behaviour that adds generated path information on the File elements.
Methods
Dispatches a logging request to log a debug message.
debug(string $message) : void
Inherited
| inherited_from |
\phpDocumentor_Transformer_Abstract::debug() |
| inherited_from |
\phpDocumentor_Transformer_Behaviour_Abstract::debug() |
Parameters
$message
stringThe message to log.
Dispatches an event to the Event Dispatcher.
dispatch(string $name, \string[] $arguments) : mixed | null
Inherited
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_Transformer_Abstract::dispatch() |
| inherited_from |
\phpDocumentor_Transformer_Behaviour_Abstract::dispatch() |
Parameters
$name
stringName of the event to dispatch.
$arguments
\string[]Arguments for this event.
Exceptions
Returns
mixednull
Dispatches a logging request.
log(string $message, int $priority) : void
Inherited
| inherited_from |
\phpDocumentor_Transformer_Abstract::log() |
| inherited_from |
\phpDocumentor_Transformer_Behaviour_Abstract::log() |
Parameters
$message
stringThe message to log.
$priority
intThe logging priority, the lower, the more important. Ranges from 1 to 7
Adds extra information to the structure.
process(DOMDocument $xml) : \DOMDocument
This method enhances the Structure information with the following
information:
- Every file receives a 'generated-path' attribute which contains the
path on the filesystem where the docs for that file van be found.
Parameters
Returns
Properties
The event dispatcher object, may be null to not dispatch events.
$event_dispatcher : \sfEventDispatcher | null
Inherited
| inherited_from |
\phpDocumentor_Transformer_Abstract::$$event_dispatcher |
| inherited_from |
\phpDocumentor_Transformer_Behaviour_Abstract::$$event_dispatcher |