Behaviour that adds generated path information on the File elements.
| category | phpDocumentor |
|---|---|
| package | Transformer |
| subpackage | Behaviour |
| author | Mike van Riel |
| license | MIT |
| link | http://phpdoc.org |
debug(string $message) : void
| inherited_from | \phpDocumentor\Transformer\TransformerAbstract::debug() |
|---|---|
| inherited_from | \phpDocumentor\Transformer\Behaviour\BehaviourAbstract::debug() |
stringThe message to log.
getTransformer() : \phpDocumentor\Transformer\Transformer
| inherited_from | \phpDocumentor\Transformer\Behaviour\BehaviourAbstract::getTransformer() |
|---|
log(string $message, int $priority) : void
| inherited_from | \phpDocumentor\Transformer\TransformerAbstract::log() |
|---|---|
| inherited_from | \phpDocumentor\Transformer\Behaviour\BehaviourAbstract::log() |
stringThe message to log.
intThe logging priority, the lower, the more important. Ranges from 1 to 7
process(\DOMDocument $xml) : \DOMDocument
This method enhances the Structure information with the following information: - Every @see tag, or a tag with a type receives an attribute with a direct link to that tag's type entry. - Every tag receives an excerpt containing the first 15 characters.
setTransformer(\phpDocumentor\Transformer\Transformer $transformer) : void
| inherited_from | \phpDocumentor\Transformer\Behaviour\BehaviourAbstract::setTransformer() |
|---|
collectClassPaths(\DOMXPath $xpath) : string[]
Returns an associative array where the key consists of the FQCN and the value of the path that is mentioned with the 'file' element.
string[]processInlineLinkTags(\DOMXPath $xpath) : void
This method recognizes two types of inline link tags and handles them differently:
\DOMXPath
$transformer : \phpDocumentor\Transformer\Transformer
| inherited_from | \phpDocumentor\Transformer\Behaviour\BehaviourAbstract::$$transformer |
|---|