phpDocumentor
Back to top  

Base class for plugin event listeners.

category phpDocumentor
package Plugin
author Mike van Riel
license MIT
link http://phpdoc.org

 Methods

Translates the ID or message in the given language.

_(string $message, array $variables) : string
Inherited

Translation messages may contain any formatting as used by the php vsprintf function.

inherited_from \phpDocumentor_Plugin_Abstract::_()

Parameters

$message

string

ID or message to translate.

$variables

array

Variables to use for substitution.

Returns

string

Registers the event dispatcher and configuration, calls the configure method and connects the hooks of this listener to the event dispatcher.

__construct(\phpDocumentor_Plugin_Abstract $plugin) 

Parameters

$plugin

\phpDocumentor_Plugin_Abstract

Plugin object to register this listener on.

Dispatches a logging request to log a debug message.

debug(string $message) : void
Inherited

inherited_from \phpDocumentor_Plugin_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_Plugin_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 configuration for this object.

getConfiguration() : \Zend_Config_Xml
Inherited

inherited_from \phpDocumentor_Plugin_Abstract::getConfiguration()

Returns

\Zend_Config_Xml

Returns the event dispatcher.

getEventDispatcher() : \sfEventDispatcher
Inherited

inherited_from \phpDocumentor_Plugin_Abstract::getEventDispatcher()

Returns

\sfEventDispatcher

Returns the translation component.

getTranslator() : \Zend_Translate_Adapter_Array | null
Inherited

inherited_from \phpDocumentor_Plugin_Abstract::getTranslator()

Returns

\Zend_Translate_Adapter_Arraynull

Dispatches a logging request.

log(string $message, int $priority) : void
Inherited

inherited_from \phpDocumentor_Plugin_Abstract::log()

Parameters

$message

string

The message to log.

$priority

int

The logging priority, the lower, the more important. Ranges from 1 to 7

Dispatches a parser error to be logged.

logParserError(string $type, $code, string $line, \string[] $variables) : void
Inherited

inherited_from \phpDocumentor_Plugin_Abstract::logParserError()

Parameters

$type

string

The logging priority as string

$code

$line

string

The line number where the error occurred..

$variables

\string[]

an array with message substitution variables.

Hook method to allow some additional processing before the hooks are connected to the dispatcher.

configure() : void

This method can be used to manually hook events to the dispatcher based instead of using the @phpdoc-event tag.

see \phpDocumentor_Plugin_Core_Listener::configure()

Scans this class for any method containing the @phpdoc-event tag and connects it to the event dispatcher.

connectHooksToDispatcher() : void

The @phpdoc-event tag has as description the name of the event to connect to. When encountered will that event be linked to the associated method. It is thus important that such a method has a single argument $event of type sfEvent. This contains the arguments that were dispatched.

 Properties

 

<p>Configuration object for plugins</p>

$configuration : \Zend_Config_Xml
Inherited

inherited_from \phpDocumentor_Plugin_Abstract::$$configuration
 

<p>Dispatcher used to send events back and forth</p>

$event_dispatcher : \sfEventDispatcher
Inherited

inherited_from \phpDocumentor_Plugin_Abstract::$$event_dispatcher
 

$plugin

$plugin 

 

<p>Translation object</p>

$translate : \Zend_Translate_Adapter_Array
Inherited

inherited_from \phpDocumentor_Plugin_Abstract::$$translate