phpDocumentor
Back to top  

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

 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

string

The 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

string

Name of the event to dispatch.

$arguments

\string[]

Arguments for this event.

Exceptions

\phpDocumentor_Parser_Exception if there is a dispatcher but it is not of type sfEventDispatcher

Returns

mixednull

Returns the transformer that hosts this behaviour.

getTransformer() : \phpDocumentor_Transformer
Inherited

inherited_from \phpDocumentor_Transformer_Behaviour_Abstract::getTransformer()

Returns

\phpDocumentor_Transformer

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

string

The message to log.

$priority

int

The 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 @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.

Parameters

$xml

\DOMDocument

Document for the structure file.

Returns

\DOMDocument

Sets the transformer used for this behaviour.

setTransformer(\phpDocumentor_Transformer $transformer) : void
Inherited

inherited_from \phpDocumentor_Transformer_Behaviour_Abstract::setTransformer()

Parameters

$transformer

\phpDocumentor_Transformer

Transformer responsible for output.

Collects an array of classes with their filesystem paths to use when generating anchors.

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.

Parameters

$xpath

\DOMXPath

The XPath object to query against.

Returns

\string[]

Scans the document for any sign of an inline link tag and replaces it with it's contents.

processInlineLinkTags(DOMXPath $xpath) : void

This method recognizes two types of inline link tags and handles them differently: * With description: [description], this shows the description as body of the anchor. * Without description: [url], this shows the url as body of the anchor.

Parameters

$xpath

\DOMXPath

 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
 

$transformer

$transformer : \phpDocumentor_Transformer
Inherited

inherited_from \phpDocumentor_Transformer_Behaviour_Abstract::$$transformer