_()
__construct()
debug()
dispatch()
getConfiguration()
getEventDispatcher()
getOptions()
getTranslator()
load()
log()
logParserError()
$author
$class_prefix
$configuration
$dependencies
$description
$event_dispatcher
$listeners
$name
$options
$translate
$version
$website
This class represents a single plugin with all it's options and properties.
| category | phpDocumentor |
|---|---|
| package | Plugin |
| author | Mike van Riel |
| license | MIT |
| link | http://phpdoc.org |
_(string $message, array $variables) : string
Translation messages may contain any formatting as used by the php vsprintf function.
| inherited_from | \phpDocumentor_Plugin_Abstract::_() |
|---|
stringID or message to translate.
arrayVariables to use for substitution.
string__construct(\sfEventDispatcher $event_dispatcher, \Zend_Config_Xml $configuration, \Zend_Translate_Adapter_Array $translator)
| inherited_from | \phpDocumentor_Plugin_Abstract::__construct() |
|---|
debug(string $message) : void
| inherited_from | \phpDocumentor_Plugin_Abstract::debug() |
|---|
stringThe message to log.
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.
| inherited_from | \phpDocumentor_Plugin_Abstract::dispatch() |
|---|
stringName of the event to dispatch.
\string[]Arguments for this event.
\phpDocumentor_Parser_Exception |
if there is a dispatcher but it is not of type sfEventDispatcher |
|---|
mixednull
getOptions() : array
arraygetTranslator() : \Zend_Translate_Adapter_Array | null
| inherited_from | \phpDocumentor_Plugin_Abstract::getTranslator() |
|---|
load(string $file, \Composer\Autoload\ClassLoader | null $autoloader) : void
If the autoloader is provided then the class' prefix is added to it.
stringPath to the configuration file.
\Composer\Autoload\ClassLoadernullAutoloader object to add the prefix/path combination to.
log(string $message, int $priority) : void
| inherited_from | \phpDocumentor_Plugin_Abstract::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_Abstract::logParserError() |
|---|
stringThe logging priority as string
stringThe line number where the error occurred..
\string[]an array with message substitution variables.
$class_prefix : string
$configuration : \Zend_Config_Xml
| inherited_from | \phpDocumentor_Plugin_Abstract::$$configuration |
|---|
$dependencies : \string[]
$description : string
$email : string
$event_dispatcher : \sfEventDispatcher
| inherited_from | \phpDocumentor_Plugin_Abstract::$$event_dispatcher |
|---|
$listeners : \string[]
$name : string
$translate : \Zend_Translate_Adapter_Array
| inherited_from | \phpDocumentor_Plugin_Abstract::$$translate |
|---|
$version : string
$website : string