Layer superclass for the Plugin Component; contains all event dispatching code.

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

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

Parameters

$message

string

ID or message to translate.

$variables

array

Variables to use for substitution.

Returns

string

Initialize this object with an Event Dispatcher and Configuration object.

__construct(\sfEventDispatcher $event_dispatcher, \Zend_Config_Xml $configuration, \Zend_Translate_Adapter_Array $translator) 

Parameters

$event_dispatcher

\sfEventDispatcher

Dispatcher used to handle events.

$configuration

\Zend_Config_Xml

Configuration object for this object.

$translator

\Zend_Translate_Adapter_Array

Translator object.

Dispatches a logging request to log a debug message.

debug(string $message) : void

Parameters

$message

string

The message to log.

Dispatches an event to the Event Dispatcher.

dispatch(string $name, \string[] $arguments) : mixed | null

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.

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

Returns the event dispatcher.

getEventDispatcher() : \sfEventDispatcher

Returns the translation component.

getTranslator() : \Zend_Translate_Adapter_Array | null

Dispatches a logging request.

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

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

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.

 Properties

 

<p>Configuration object for plugins</p>

$configuration : \Zend_Config_Xml

 

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

$event_dispatcher : \sfEventDispatcher

 

<p>Translation object</p>

$translate : \Zend_Translate_Adapter_Array