diff options
Diffstat (limited to 'program/include/rcube_plugin.php')
| -rw-r--r-- | program/include/rcube_plugin.php | 44 |
1 files changed, 29 insertions, 15 deletions
diff --git a/program/include/rcube_plugin.php b/program/include/rcube_plugin.php index 5e5f56496..0c7f56648 100644 --- a/program/include/rcube_plugin.php +++ b/program/include/rcube_plugin.php @@ -27,6 +27,12 @@ abstract class rcube_plugin { public $ID; + + /** + * Holds an istance of Plugin API + * + * @var rcube_plugin_api + */ public $api; public $task; protected $home; @@ -35,6 +41,8 @@ abstract class rcube_plugin /** * Default constructor. + * + * @param rcube_plugin_api $api Plugin API */ public function __construct($api) { @@ -53,7 +61,7 @@ abstract class rcube_plugin * Load local config file from plugins directory. * The loaded values are patched over the global configuration. * - * @param string Config file name relative to the plugin's folder + * @param string $fname Config file name relative to the plugin's folder * @return boolean True on success, false on failure */ public function load_config($fname = 'config.inc.php') @@ -73,8 +81,8 @@ abstract class rcube_plugin /** * Register a callback function for a specific (server-side) hook * - * @param string Hook name - * @param mixed Callback function as string or array with object reference and method name + * @param string $hook Hook name + * @param mixed $callback Callback function as string or array with object reference and method name */ public function add_hook($hook, $callback) { @@ -84,8 +92,8 @@ abstract class rcube_plugin /** * Load localized texts from the plugins dir * - * @param string Directory to search in - * @param mixed Make texts also available on the client (array with list or true for all) + * @param string $dir Directory to search in + * @param mixed $add2client Make texts also available on the client (array with list or true for all) */ public function add_texts($dir, $add2client = false) { @@ -120,6 +128,7 @@ abstract class rcube_plugin /** * Wrapper for rcmail::gettext() adding the plugin ID as domain * + * @param string $p Message identifier * @return string Localized text * @see rcmail::gettext() */ @@ -131,7 +140,7 @@ abstract class rcube_plugin /** * Register this plugin to be responsible for a specific task * - * @param string Task name (only characters [a-z0-9_.-] are allowed) + * @param string $task Task name (only characters [a-z0-9_.-] are allowed) */ public function register_task($task) { @@ -144,8 +153,8 @@ abstract class rcube_plugin * * The callback will be executed upon a request like /?_task=mail&_action=plugin.myaction * - * @param string Action name (should be unique) - * @param mixed Callback function as string or array with object reference and method name + * @param string $action Action name (should be unique) + * @param mixed $callback Callback function as string or array with object reference and method name */ public function register_action($action, $callback) { @@ -158,8 +167,8 @@ abstract class rcube_plugin * When parsing a template for display, tags like <roundcube:object name="plugin.myobject" /> * will be replaced by the return value if the registered callback function. * - * @param string Object name (should be unique and start with 'plugin.') - * @param mixed Callback function as string or array with object reference and method name + * @param string $name Object name (should be unique and start with 'plugin.') + * @param mixed $callback Callback function as string or array with object reference and method name */ public function register_handler($name, $callback) { @@ -169,7 +178,7 @@ abstract class rcube_plugin /** * Make this javascipt file available on the client * - * @param string File path; absolute or relative to the plugin directory + * @param string $fn File path; absolute or relative to the plugin directory */ public function include_script($fn) { @@ -179,7 +188,7 @@ abstract class rcube_plugin /** * Make this stylesheet available on the client * - * @param string File path; absolute or relative to the plugin directory + * @param string $fn File path; absolute or relative to the plugin directory */ public function include_stylesheet($fn) { @@ -189,8 +198,8 @@ abstract class rcube_plugin /** * Append a button to a certain container * - * @param array Hash array with named parameters (as used in skin templates) - * @param string Container name where the buttons should be added to + * @param array $p Hash array with named parameters (as used in skin templates) + * @param string $container Container name where the buttons should be added to * @see rcube_remplate::button() */ public function add_button($p, $container) @@ -209,7 +218,7 @@ abstract class rcube_plugin * Generate an absolute URL to the given resource within the current * plugin directory * - * @param string The file name + * @param string $fn The file name * @return string Absolute URL to the given resource */ public function url($fn) @@ -219,6 +228,8 @@ abstract class rcube_plugin /** * Make the given file name link into the plugin directory + * + * @param string $fn Filename */ private function resource_url($fn) { @@ -244,6 +255,9 @@ abstract class rcube_plugin /** * Callback function for array_map + * + * @param string $key Array key. + * @return string */ private function label_map_callback($key) { |