| [ Index ] |
|
Code source de DokuWiki 2006-11-06 |
[Code source] [Imprimer] [Statistiques]
Admin Plugin Prototype
| Author: | Christopher Smith <chris@jalakai.co.uk> |
| License: | GPL 2 (http://www.gnu.org/licenses/gpl.html) |
| Poids: | 211 lignes (7 kb) |
| Inclus ou requis: | 2 fois |
| Référencé: | 0 fois |
| Nécessite: | 0 fichiers |
DokuWiki_Plugin:: (19 méthodes):
getInfo()
getPluginType()
getPluginName()
getPluginComponent()
getLang()
locale_xhtml()
localFN()
setupLocale()
getConf()
loadConfig()
readDefaultSettings()
email()
external_link()
render()
plugin_localFN()
plugin_locale_xhtml()
plugin_email()
plugin_link()
plugin_render()
Classe: DokuWiki_Plugin - X-Ref
All DokuWiki plugins to extend the admin function| getInfo() X-Ref |
| General Info Needs to return a associative array with the following values: author - Author of the plugin email - Email address to contact the author date - Last modified date of the plugin in YYYY-MM-DD format name - Name of the plugin desc - Short description of the plugin (Text only) url - Website with more information on the plugin (eg. syntax description) |
| getPluginType() X-Ref |
| Pas de description |
| getPluginName() X-Ref |
| Pas de description |
| getPluginComponent() X-Ref |
| Pas de description |
| getLang($id) X-Ref |
| getLang($id) use this function to access plugin language strings to try to minimise unnecessary loading of the strings when the plugin doesn't require them e.g. when info plugin is querying plugins for information about themselves. param: $id id of the string to be retrieved return: string string in appropriate language or english if not available |
| locale_xhtml($id) X-Ref |
| locale_xhtml($id) retrieve a language dependent file and pass to xhtml renderer for display plugin equivalent of p_locale_xhtml() param: $id id of language dependent wiki page return: string parsed contents of the wiki page in xhtml format |
| localFN($id) X-Ref |
| localFN($id) prepends appropriate path for a language dependent filename plugin equivalent of localFN() |
| setupLocale() X-Ref |
| setupLocale() reads all the plugins language dependent strings into $this->lang this function is automatically called by getLang() |
| getConf($setting) X-Ref |
| getConf($setting) use this function to access plugin configuration variables |
| loadConfig() X-Ref |
| loadConfig() merges the plugin's default settings with any local settings this function is automatically called through getConf() |
| readDefaultSettings() X-Ref |
| read the plugin's default configuration settings from conf/default.php this function is automatically called through getConf() return: array setting => value |
| email($email, $name='', $class='', $more='') X-Ref |
| email standardised function to generate an email link according to obfuscation settings |
| external_link($link, $title='', $class='', $target='', $more='') X-Ref |
| external_link standardised function to generate an external link according to conf settings |
| render($text, $format='xhtml') X-Ref |
| output text string through the parser, allows dokuwiki markup to be used very ineffecient for small pieces of data - try not to use |
| plugin_localFN($id) X-Ref |
| Pas de description |
| plugin_locale_xhtml($id) X-Ref |
| Pas de description |
| plugin_email($e, $n='', $c='', $m='') X-Ref |
| Pas de description |
| plugin_link($l, $t='', $c='', $to='', $m='') X-Ref |
| Pas de description |
| plugin_render($t, $f='xhtml') X-Ref |
| Pas de description |
| Généré le : Tue Apr 3 20:47:31 2007 | par Balluche grâce à PHPXref 0.7 |