Behaviour that links to email addresses in the @author tag.

PHP Version 5

category phpDocumentor
package Transformer
subpackage Behaviours
author David Zülke
author Mike van Riel
copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
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

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

Find all return tags that contain 'self' or '$this' and replace those terms for the name of the current class' type.

process(DOMDocument $xml) : \DOMDocument

Parameters

$xml

\DOMDocument

Structure source to apply behaviour onto.

Returns

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.

 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