TranslatorPlugin Class Reference
[Plugins_generic_translator]
This plugin helps with translation maintenance.
More...
Public Member Functions | |
| getDescription () | |
| getDisplayName () | |
| getManagementVerbs () | |
| getName () | |
| isSitePlugin () | |
| manage ($verb, $args) | |
| register ($category, $path) | |
Detailed Description
This plugin helps with translation maintenance.Definition at line 20 of file TranslatorPlugin.inc.php.
Member Function Documentation
| TranslatorPlugin.getDescription | ( | ) |
Get a description of this plugin.
Reimplemented from Plugin.
Definition at line 56 of file TranslatorPlugin.inc.php.
References Locale.translate().
| TranslatorPlugin.getDisplayName | ( | ) |
Get the display name for this plugin.
- Returns:
- string
Reimplemented from Plugin.
Definition at line 52 of file TranslatorPlugin.inc.php.
References Locale.translate().
| TranslatorPlugin.getManagementVerbs | ( | ) |
Get a list of management actions in the form of a page => value pair. The management actions from this list are passed to the manage() function when called.
Reimplemented from Plugin.
Definition at line 60 of file TranslatorPlugin.inc.php.
References Locale.translate().
| TranslatorPlugin.getName | ( | ) |
Get the name of this plugin. The name must be unique within its category, and should be suitable for part of a filename (ie short, no spaces, and no dependencies on cases being unique).
- Returns:
- String name of plugin
Reimplemented from Plugin.
Definition at line 48 of file TranslatorPlugin.inc.php.
| TranslatorPlugin.isSitePlugin | ( | ) |
Site-wide plugins should override this function to return true.
Reimplemented from Plugin.
Definition at line 93 of file TranslatorPlugin.inc.php.
| TranslatorPlugin.manage | ( | $ | verb, | |
| $ | args | |||
| ) |
Perform a management function.
Reimplemented from Plugin.
Definition at line 76 of file TranslatorPlugin.inc.php.
References Validation.isSiteAdmin(), Request.redirect(), and Plugin.updateSetting().
| TranslatorPlugin.register | ( | $ | category, | |
| $ | path | |||
| ) |
Called as a plugin is registered to the registry. Subclasses over- riding this method should call the parent method first.
- Parameters:
-
$category String Name of category plugin was registered to $path String The path the plugin was found in
- Returns:
- boolean True iff plugin initialized successfully; if false, the plugin will not be registered.
Reimplemented from Plugin.
Definition at line 21 of file TranslatorPlugin.inc.php.
References Plugin.addHelpData(), Plugin.addLocaleData(), and HookRegistry.register().
The documentation for this class was generated from the following file:
- plugins/generic/translator/TranslatorPlugin.inc.php
