SehlPlugin Class Reference
[Plugins_generic_sehl]
Search Engine HighLighting plugin.
More...
Public Member Functions | |
| getDescription () | |
| getDisplayName () | |
| getManagementVerbs () | |
| getName () | |
| manage ($verb, $args) | |
| register ($category, $path) | |
Detailed Description
Search Engine HighLighting plugin.Definition at line 20 of file SehlPlugin.inc.php.
Member Function Documentation
| SehlPlugin.getDescription | ( | ) |
Get a description of this plugin.
Reimplemented from Plugin.
Definition at line 139 of file SehlPlugin.inc.php.
References Locale.translate().
| SehlPlugin.getDisplayName | ( | ) |
Get the display name for this plugin.
- Returns:
- string
Reimplemented from Plugin.
Definition at line 135 of file SehlPlugin.inc.php.
References Locale.translate().
| SehlPlugin.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 149 of file SehlPlugin.inc.php.
References Locale.translate().
| SehlPlugin.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 131 of file SehlPlugin.inc.php.
| SehlPlugin.manage | ( | $ | verb, | |
| $ | args | |||
| ) |
Perform a management function.
Reimplemented from Plugin.
Definition at line 156 of file SehlPlugin.inc.php.
References Request.getJournal(), and Plugin.updateSetting().
| SehlPlugin.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 24 of file SehlPlugin.inc.php.
References Plugin.addLocaleData(), Request.getJournal(), and HookRegistry.register().
The documentation for this class was generated from the following file:
- plugins/generic/sehl/SehlPlugin.inc.php
