phpDocumentor » \phpDocumentor_Plugin_Core

Listener for the Core Plugin.

category	phpDocumentor
package	Plugin
subpackage	Core
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::_()
inherited_from	\phpDocumentor_Plugin_ListenerAbstract::_()

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)

Inherited

inherited_from	\phpDocumentor_Plugin_ListenerAbstract::__construct()

Parameters

$plugin

\phpDocumentor_Plugin_Abstract

Plugin object to register this listener on.

Applies all behaviours prior to transformation.

applyBehaviours(sfEvent $data) : void

phpdoc-event	transformer.transform.pre

Parameters

$data

\sfEvent

Event object containing the parameters.

Dispatches a logging request to log a debug message.

debug(string $message) : void

Inherited

inherited_from	\phpDocumentor_Plugin_Abstract::debug()
inherited_from	\phpDocumentor_Plugin_ListenerAbstract::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()
inherited_from	\phpDocumentor_Plugin_ListenerAbstract::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

Prepare the tag to be injected into the XML file.

exportTag(sfEvent $data) : void

phpdoc-event	reflection.docblock.tag.export

Parameters

$data

\sfEvent

Event object containing the parameters.

Returns the configuration for this object.

getConfiguration() : \Zend_Config_Xml

Inherited

inherited_from	\phpDocumentor_Plugin_Abstract::getConfiguration()
inherited_from	\phpDocumentor_Plugin_ListenerAbstract::getConfiguration()

Returns

\Zend_Config_Xml

Returns the event dispatcher.

getEventDispatcher() : \sfEventDispatcher

Inherited

inherited_from	\phpDocumentor_Plugin_Abstract::getEventDispatcher()
inherited_from	\phpDocumentor_Plugin_ListenerAbstract::getEventDispatcher()

Returns

\sfEventDispatcher

Returns the translation component.

getTranslator() : \Zend_Translate_Adapter_Array | null

Inherited

inherited_from	\phpDocumentor_Plugin_Abstract::getTranslator()
inherited_from	\phpDocumentor_Plugin_ListenerAbstract::getTranslator()

Returns

\Zend_Translate_Adapter_Arraynull

Dispatches a logging request.

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

Inherited

inherited_from	\phpDocumentor_Plugin_Abstract::log()
inherited_from	\phpDocumentor_Plugin_ListenerAbstract::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()
inherited_from	\phpDocumentor_Plugin_ListenerAbstract::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.

Checks all phpDocumentor whether they match the given rules.

validateDocBlocks(sfEvent $data) : void

phpdoc-event	reflection.docblock-extraction.post

Parameters

$data

\sfEvent

Event object containing the parameters.

Configures this listener; initializes and connects the logger.

configure() : void

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

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

connectHooksToDispatcher() : void

Inherited

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.

inherited_from	\phpDocumentor_Plugin_ListenerAbstract::connectHooksToDispatcher()

Load the configuration from the plugin.xml file

loadConfiguration() : array

Returns

array

Load the configuration for given element (deprecated/required)

loadConfigurationByElement(array $configOptions, string $configType) : array

Parameters

$configOptions

array

The configuration from the plugin.xml file

$configType

string

Required/Deprecated for the time being

Returns

array

Properties

Configuration object for plugins

$configuration : \Zend_Config_Xml

Inherited

inherited_from	\phpDocumentor_Plugin_Abstract::$$configuration
inherited_from	\phpDocumentor_Plugin_ListenerAbstract::$$configuration

Dispatcher used to send events back and forth

$event_dispatcher : \sfEventDispatcher

Inherited

inherited_from	\phpDocumentor_Plugin_Abstract::$$event_dispatcher
inherited_from	\phpDocumentor_Plugin_ListenerAbstract::$$event_dispatcher

Logger for phpDocumentor

$logger : \phpDocumentor_Plugin_Core_Log

$plugin

$plugin

Inherited

inherited_from	\phpDocumentor_Plugin_ListenerAbstract::$$plugin

Translation object

$translate : \Zend_Translate_Adapter_Array

Inherited

inherited_from	\phpDocumentor_Plugin_Abstract::$$translate
inherited_from	\phpDocumentor_Plugin_ListenerAbstract::$$translate

Methods

Translates the ID or message in the given language.

Parameters

$message

$variables

Returns

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

Parameters

$plugin

Applies all behaviours prior to transformation.

Parameters

$data

Dispatches a logging request to log a debug message.

Parameters

$message

Dispatches an event to the Event Dispatcher.

Parameters

$name

$arguments

Exceptions

Returns

Prepare the tag to be injected into the XML file.

Parameters

$data

Returns the configuration for this object.

Returns

Returns the event dispatcher.

Returns

Returns the translation component.

Returns

Dispatches a logging request.

Parameters

$message

$priority

Dispatches a parser error to be logged.

Parameters

$type

$code

$line

$variables

Checks all phpDocumentor whether they match the given rules.

Parameters

$data

Configures this listener; initializes and connects the logger.

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

Load the configuration from the plugin.xml file

Returns

Load the configuration for given element (deprecated/required)

Parameters

$configOptions

$configType

Returns

Properties

<p>Configuration object for plugins</p>

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

<p>Logger for phpDocumentor</p>

$plugin

<p>Translation object</p>