extern/egroupware_official
1
0
Fork 0
mirror of https://github.com/EGroupware/egroupware.git synced 2024-11-22 16:03:47 +01:00
Code Issues Packages Projects Releases Wiki Activity

allow all php callables (eg. "class::method" for static calls) for ExecMethod, ExecMethod2 and as methodstring for hooks

Browse Source
This commit is contained in:
Ralf Becker 2008-04-25 18:54:06 +00:00
parent a8b924696f
commit 4ecce4f5ae
2 changed files with 50 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
phpgwapi/inc/class.hooks.inc.php
View File

@ -1,7 +1,7 @@
<?php
/**
* eGroupWare API - Hooks
*
*
* @link http://www.egroupware.org
* @author Dan Kuykendall <seek3r@phpgroupware.org>
* @author Ralf Becker <RalfBecker-AT-outdoor-training.de>
@ -16,18 +16,20 @@
* class which gives ability for applications to set and use hooks to communicate with each other
*
* Hooks need to be declared in the app's setup.inc.php file and they have to be registered
* (copied into the database) by
* - installing or updating the app via setup or
* (copied into the database) by
* - installing or updating the app via setup or
* - running Admin >> register all hooks
* As the hooks-class can get cached in the session (session-type PHP_RESTORE), you also have to log
* out and in again, that your changes take effect.
*
* Hooks can either have two formats
* - new method hooks (prefered), which are methods of a class. You can pass parameters to the call and
* they can return values. They get declared in setup.inc.php as:
* Hooks can have one of the following formats:
* - static class method hooks are declared as:
* $setup_info['appname']['hooks']['location'] = 'class::method';
* - method hooks, which are methods of a class. You can pass parameters to the call and
* they can return values. They get declared in setup.inc.php as:
* $setup_info['appname']['hooks']['location'] = 'app.class.method';
* - old type, which are included files. Values can only be passed by global values and they cant return anything.
* Old declaration in setup.inc.php:
* Old declaration in setup.inc.php:
* $setup_info['appname']['hooks'][] = 'location';
*/
class hooks
@ -56,17 +58,17 @@ class hooks
}
//_debug_array($this->found_hooks);
}
/**
* executes all the hooks (the user has rights to) for a given location
* executes all the hooks (the user has rights to) for a given location
*
* @param string/array $args location-name as string or array with keys location, order and
* @param string/array $args location-name as string or array with keys location, order and
* further data to be passed to the hook, if its a new method-hook
* @param array $order appnames (as value), which should be executes first
* @param boolean $no_permission_check if True execute all hooks, not only the ones a user has rights to
* $no_permission_check should *ONLY* be used when it *HAS* to be. (jengo)
* @return array with results of each hook call (with appname as key) and value:
* - False if no hook exists,
* - False if no hook exists,
* - True if old hook exists and
* - whatever the new method-hook returns (can be True or False too!).
*/
@ -75,7 +77,7 @@ class hooks
//echo "<p>hooks::process("; print_r($args); echo ")</p>\n";
if ($order == '')
{
$order = is_array($args) && isset($args['order']) ? $args['order'] :
$order = is_array($args) && isset($args['order']) ? $args['order'] :
array($GLOBALS['egw_info']['flags']['currentapp']);
}
@ -114,7 +116,7 @@ class hooks
/**
* executes a single hook of a given location and application
*
* @param string/array $args location-name as string or array with keys location, appname and
* @param string/array $args location-name as string or array with keys location, appname and
* further data to be passed to the hook, if its a new method-hook
* @param string $appname name of the app, which's hook to execute, if empty the current app is used
* @param boolean $no_permission_check if True execute all hooks, not only the ones a user has rights to
@ -143,9 +145,15 @@ class hooks
if (isset($this->found_hooks[$appname][$location]) || $try_unregistered)
{
$parts = explode('.',$method = $this->found_hooks[$appname][$location]);
if (count($parts) != 3 || ($parts[1] == 'inc' && $parts[2] == 'php'))
if (strpos($method,'::') !== false || count($parts) == 3 && $parts[1] != 'inc' && $parts[2] != 'php')
{
// new style hook with method string or static method (eg. 'class::method')
return ExecMethod($method,$args);
}
else
{
// old style hook, with an include file
if ($try_unregistered && empty($method))
{
$method = 'hook_'.$location.'.inc.php';
@ -162,10 +170,6 @@ class hooks
return False;
}
}
else // new style method-hook
{
return ExecMethod($method,$args);
}
}
else
{
@ -191,7 +195,7 @@ class hooks
}
return $count;
}
/**
* @deprecated currently not being used
*/
@ -209,7 +213,7 @@ class hooks
*
* First all existing hooks of $appname get deleted in the db and then the given ones get registered.
*
* @param string $appname Application 'name'
* @param string $appname Application 'name'
* @param array $hooks=null hooks to register, eg $setup_info[$app]['hooks'] or not used for only deregister the hooks
* @return boolean false on error, true otherwise
*/
@ -248,16 +252,16 @@ class hooks
return True;
}
/**
* Register the hooks of all applications (used by admin)
*/
function register_all_hooks()
{
$SEP = filesystem_separator();
foreach($GLOBALS['egw_info']['apps'] as $appname => $app)
{
{
$f = EGW_SERVER_ROOT . $SEP . $appname . $SEP . 'setup' . $SEP . 'setup.inc.php';
if(@file_exists($f))
{

35
phpgwapi/inc/common_functions.inc.php
View File

@ -731,22 +731,25 @@
*/
function &ExecMethod2($acm)
{
list($app,$class,$method) = explode('.',$acm);
if (!is_object($obj =& $GLOBALS[$class]))
if (!is_callable($acm))
{
$obj =& CreateObject($acm);
}
list($app,$class,$method) = explode('.',$acm);
if (!is_object($obj =& $GLOBALS[$class]))
{
$obj =& CreateObject($acm);
}
if (!method_exists($obj,$method))
{
echo "<p><b>".function_backtrace()."</b>: no methode '$method' in class '$class'</p>\n";
return False;
if (!method_exists($obj,$method))
{
echo "<p><b>".function_backtrace()."</b>: no methode '$method' in class '$class'</p>\n";
return False;
}
$acm = array($obj,$method);
}
$args = func_get_args();
unset($args[0]);
return call_user_func_array(array($obj,$method),$args);
return call_user_func_array($acm,$args);
}
/**
@ -756,16 +759,16 @@
*
* @author seek3r
* @param $method to execute
* @param $functionparams function param should be an array
* @param $functionparam function param should be an array
* @param $loglevel developers choice of logging level
* @param $classparams params to be sent to the contructor
* @return mixed returnvalue of method
*/
function ExecMethod($method, $functionparams = '_UNDEF_', $loglevel = 3, $classparams = '_UNDEF_')
function ExecMethod($method, $functionparam = '_UNDEF_', $loglevel = 3, $classparams = '_UNDEF_')
{
/* Need to make sure this is working against a single dimensional object */
$partscount = count(explode('.',$method)) - 1;
if ($partscount == 2)
if (!is_callable($method) && $partscount == 2)
{
list($appname,$classname,$functionname) = explode(".", $method);
if (!is_object($GLOBALS[$classname]))
@ -786,6 +789,12 @@
echo "<p><b>".function_backtrace()."</b>: no methode '$functionname' in class '$classname'</p>\n";
return False;
}
$method = array($GLOBALS[$classname],$functionname);
}
if (is_callable($method))
{
return $functionparam != '_UNDEF_' ? call_user_func($method,$functionparam) : call_user_func($method);
if ((is_array($functionparams) || $functionparams != '_UNDEF_') && ($functionparams || $functionparams != 'True'))
{
return $GLOBALS[$classname]->$functionname($functionparams);