Listener for the Core Plugin.
| author | Mike van Riel |
|---|
_(string $message, array $variables) : string
Translation messages may contain any formatting as used by the php vsprintf function.
| inherited_from | \phpDocumentor\Plugin\PluginAbstract::_() |
|---|---|
| inherited_from | \phpDocumentor\Plugin\ListenerAbstract::_() |
stringID or message to translate.
arrayVariables to use for substitution.
string__construct(\phpDocumentor\Plugin\PluginAbstract $plugin)
| inherited_from | \phpDocumentor\Plugin\ListenerAbstract::__construct() |
|---|
applyBehaviours(\phpDocumentor\Transformer\Event\PreTransformationEvent $data) : void
| phpdoc-event | transformer.transform.pre |
|---|
\phpDocumentor\Transformer\Event\PreTransformationEventEvent object containing the parameters.
\phpDocumentor\Plugin\Core\Exception |
if the event does not originate from the Transformer |
|---|
debug(string $message) : void
| inherited_from | \phpDocumentor\Plugin\PluginAbstract::debug() |
|---|---|
| inherited_from | \phpDocumentor\Plugin\ListenerAbstract::debug() |
stringThe message to log.
dispatch(string $name, \phpDocumentor\Event\EventAbstract $event) : void
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\PluginAbstract::dispatch() |
|---|---|
| inherited_from | \phpDocumentor\Plugin\ListenerAbstract::dispatch() |
stringName of the event to dispatch.
\phpDocumentor\Plugin\Exception |
if there is a dispatcher but it is not of type EventDispatcher |
|---|
exportTag(\phpDocumentor\Reflection\Event\ExportDocBlockTagEvent $data) : void
| phpdoc-event | reflection.docblock.tag.export |
|---|
\phpDocumentor\Reflection\Event\ExportDocBlockTagEventEvent object containing the parameters.
getConfiguration() : \Zend\Config\Config
| inherited_from | \phpDocumentor\Plugin\PluginAbstract::getConfiguration() |
|---|---|
| inherited_from | \phpDocumentor\Plugin\ListenerAbstract::getConfiguration() |
\Zend\Config\ConfiggetEventDispatcher() : \phpDocumentor\Event\Dispatcher
| inherited_from | \phpDocumentor\Plugin\PluginAbstract::getEventDispatcher() |
|---|---|
| inherited_from | \phpDocumentor\Plugin\ListenerAbstract::getEventDispatcher() |
getTranslator() : \Zend\I18n\Translator\Translator | null
| inherited_from | \phpDocumentor\Plugin\PluginAbstract::getTranslator() |
|---|---|
| inherited_from | \phpDocumentor\Plugin\ListenerAbstract::getTranslator() |
\Zend\I18n\Translator\Translatornull
log(string $message, int $priority) : void
| inherited_from | \phpDocumentor\Plugin\PluginAbstract::log() |
|---|---|
| inherited_from | \phpDocumentor\Plugin\ListenerAbstract::log() |
stringThe message to log.
intThe logging priority, the lower, the more important. Ranges from 1 to 7
logParserError(string $type, $code, string $line, string[] $variables) : void
| inherited_from | \phpDocumentor\Plugin\PluginAbstract::logParserError() |
|---|---|
| inherited_from | \phpDocumentor\Plugin\ListenerAbstract::logParserError() |
stringThe logging priority as string
stringThe line number where the error occurred..
string[]an array with message substitution variables.
validateDocBlocks(\phpDocumentor\Reflection\Event\PostDocBlockExtractionEvent $data) : void
| phpdoc-event | reflection.docblock-extraction.post |
|---|
\phpDocumentor\Reflection\Event\PostDocBlockExtractionEventEvent object containing the parameters.
configure() : void
This method can be used to manually hook events to the dispatcher based instead of using the @phpdoc-event tag.
| see | for an example of use. |
|---|---|
| inherited_from | \phpDocumentor\Plugin\ListenerAbstract::configure() |
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.
| inherited_from | \phpDocumentor\Plugin\ListenerAbstract::connectHooksToDispatcher() |
|---|
loadConfiguration() : array
arrayloadConfigurationByElement(array $configOptions, string $configType) : array
arrayThe configuration from the plugin.xml file
stringRequired/Deprecated for the time being
array$configuration : \Zend\Config\Config
| inherited_from | \phpDocumentor\Plugin\PluginAbstract::$$configuration |
|---|---|
| inherited_from | \phpDocumentor\Plugin\ListenerAbstract::$$configuration |
$event_dispatcher : \phpDocumentor\Event\Dispatcher
| inherited_from | \phpDocumentor\Plugin\PluginAbstract::$$event_dispatcher |
|---|---|
| inherited_from | \phpDocumentor\Plugin\ListenerAbstract::$$event_dispatcher |
$plugin : \phpDocumentor\Plugin\PluginAbstract
| inherited_from | \phpDocumentor\Plugin\ListenerAbstract::$$plugin |
|---|
$translate : \Zend\I18n\Translator\Translator
| inherited_from | \phpDocumentor\Plugin\PluginAbstract::$$translate |
|---|---|
| inherited_from | \phpDocumentor\Plugin\ListenerAbstract::$$translate |