/**
* plugin.php
*
- * Copyright (c) 1999-2004 The SquirrelMail Project Team
+ * Copyright (c) 1999-2005 The SquirrelMail Project Team
* Licensed under the GNU GPL. For full terms see the file COPYING.
*
* This file provides the framework for a plugin architecture.
*
* Documentation on how to write plugins might show up some time.
*
- * $Id$
+ * @version $Id$
* @package squirrelmail
*/
* @return mixed $data
*/
function do_hook ($name) {
- global $squirrelmail_plugin_hooks;
+ global $squirrelmail_plugin_hooks, $currentHookName;
$data = func_get_args();
- $ret = '';
+ $currentHookName = $name;
if (isset($squirrelmail_plugin_hooks[$name])
&& is_array($squirrelmail_plugin_hooks[$name])) {
}
}
+ $currentHookName = '';
+
/* Variable-length argument lists have a slight problem when */
/* passing values by reference. Pity. This is a workaround. */
return $data;
* @return mixed the return value of the hook function
*/
function do_hook_function($name,$parm=NULL) {
- global $squirrelmail_plugin_hooks;
+ global $squirrelmail_plugin_hooks, $currentHookName;
$ret = '';
+ $currentHookName = $name;
if (isset($squirrelmail_plugin_hooks[$name])
&& is_array($squirrelmail_plugin_hooks[$name])) {
}
}
+ $currentHookName = '';
+
/* Variable-length argument lists have a slight problem when */
/* passing values by reference. Pity. This is a workaround. */
return $ret;
* @return string a concatenation of the results of each plugin function
*/
function concat_hook_function($name,$parm=NULL) {
- global $squirrelmail_plugin_hooks;
+ global $squirrelmail_plugin_hooks, $currentHookName;
$ret = '';
+ $currentHookName = $name;
if (isset($squirrelmail_plugin_hooks[$name])
&& is_array($squirrelmail_plugin_hooks[$name])) {
}
}
+ $currentHookName = '';
+
/* Variable-length argument lists have a slight problem when */
/* passing values by reference. Pity. This is a workaround. */
return $ret;
* @return bool the result of the function
*/
function boolean_hook_function($name,$parm=NULL,$priority=0,$tie=false) {
- global $squirrelmail_plugin_hooks;
+ global $squirrelmail_plugin_hooks, $currentHookName;
$yea = 0;
$nay = 0;
$ret = $tie;
is_array($squirrelmail_plugin_hooks[$name])) {
/* Loop over the plugins that registered the hook */
+ $currentHookName = $name;
foreach ($squirrelmail_plugin_hooks[$name] as $function) {
if (function_exists($function)) {
$ret = $function($parm);
}
}
}
+ $currentHookName = '';
/* Examine the aftermath and assign the return value appropriately */
if (($priority > 0) && ($yea)) {
* be broken. If so, returns true and the plugin is invisible to the
* offending browser.
* *** THIS IS A TEST FOR JAVASCRIPT SUPPORT ***
- * This function needs to have its name changed!
+ * FIXME: This function needs to have its name changed!
*
* @return bool whether this browser properly supports JavaScript
*/
}
}
-?>
+?>
\ No newline at end of file