From ce92ba767a9557daf7f18be94882dd7e6f4591fb Mon Sep 17 00:00:00 2001
From: alecpl <alec@alec.pl>
Date: Thu, 30 Sep 2010 09:24:33 -0400
Subject: [PATCH] - Plugin API: improved 'abort' flag handling, added 'result' item in some hooks: group_*, contact_*, identity_* (#1486914)
---
program/include/rcube_plugin.php | 66 +++++++++++++++++---------------
1 files changed, 35 insertions(+), 31 deletions(-)
diff --git a/program/include/rcube_plugin.php b/program/include/rcube_plugin.php
index e8fb22b..0c7f566 100644
--- a/program/include/rcube_plugin.php
+++ b/program/include/rcube_plugin.php
@@ -4,8 +4,8 @@
+-----------------------------------------------------------------------+
| program/include/rcube_plugin.php |
| |
- | This file is part of the RoundCube Webmail client |
- | Copyright (C) 2008-2009, RoundCube Dev. - Switzerland |
+ | This file is part of the Roundcube Webmail client |
+ | Copyright (C) 2008-2009, Roundcube Dev. - Switzerland |
| Licensed under the GNU GPL |
| |
| PURPOSE: |
@@ -27,13 +27,22 @@
abstract class rcube_plugin
{
public $ID;
+
+ /**
+ * Holds an istance of Plugin API
+ *
+ * @var rcube_plugin_api
+ */
public $api;
public $task;
protected $home;
protected $urlbase;
+ private $mytask;
/**
* Default constructor.
+ *
+ * @param rcube_plugin_api $api Plugin API
*/
public function __construct($api)
{
@@ -52,7 +61,7 @@
* 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')
@@ -72,8 +81,8 @@
/**
* 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)
{
@@ -83,8 +92,8 @@
/**
* 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)
{
@@ -119,6 +128,7 @@
/**
* Wrapper for rcmail::gettext() adding the plugin ID as domain
*
+ * @param string $p Message identifier
* @return string Localized text
* @see rcmail::gettext()
*/
@@ -130,23 +140,12 @@
/**
* 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)
{
- if ($task != asciiwords($task)) {
- raise_error(array('code' => 526, 'type' => 'php',
- 'file' => __FILE__, 'line' => __LINE__,
- 'message' => "Invalid task name: $task. Only characters [a-z0-9_.-] are allowed"), true, false);
- }
- else if (in_array(rcmail::$main_tasks, $task)) {
- raise_error(array('code' => 526, 'type' => 'php',
- 'file' => __FILE__, 'line' => __LINE__,
- 'message' => "Cannot register taks $task; already taken by another plugin or the application itself"), true, false);
- }
- else {
- rcmail::$main_tasks[] = $task;
- }
+ if ($this->api->register_task($task, $this->ID))
+ $this->mytask = $task;
}
/**
@@ -154,12 +153,12 @@
*
* 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)
{
- $this->api->register_action($action, $this->ID, $callback);
+ $this->api->register_action($action, $this->ID, $callback, $this->mytask);
}
/**
@@ -168,8 +167,8 @@
* 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)
{
@@ -179,7 +178,7 @@
/**
* 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)
{
@@ -189,7 +188,7 @@
/**
* 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)
{
@@ -199,8 +198,8 @@
/**
* 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)
@@ -219,7 +218,7 @@
* 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)
@@ -229,6 +228,8 @@
/**
* Make the given file name link into the plugin directory
+ *
+ * @param string $fn Filename
*/
private function resource_url($fn)
{
@@ -254,6 +255,9 @@
/**
* Callback function for array_map
+ *
+ * @param string $key Array key.
+ * @return string
*/
private function label_map_callback($key)
{
--
Gitblit v1.9.1