mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-03-14 12:40:01 +01:00
Code Issues Projects Releases Wiki Activity

MDL-41885 lib: Introduce component_callback_exists

Browse Source 
Determines if a callback in a module exists without needing to
call that callback.
This commit is contained in:
Dan Poltawski 2013-09-20 10:29:02 +08:00
parent 7f3836d15a
commit f5dfefdc87
1 changed files with 30 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
lib/moodlelib.php
View File

@ -7221,10 +7221,35 @@ function plugin_callback($type, $name, $feature, $action, $params = null, $defau
* @param array $params parameters of callback function
* @param mixed $default default value if callback function hasn't been defined, or if it retursn null.
* @return mixed
* @throws coding_exception
*/
function component_callback($component, $function, array $params = array(), $default = null) {
global $CFG; // This is needed for require_once() below.
$functionname = component_callback_exists($component, $function);
if ($functionname) {
// Function exists, so just return function result.
$ret = call_user_func_array($functionname, $params);
if (is_null($ret)) {
return $default;
} else {
return $ret;
}
}
return $default;
}
/**
* Determine if a component callback exists and return the function name to call. Note that this
* function will include the required library files so that the functioname returned can be
* called directly.
*
* @param string $component frankenstyle component name, e.g. 'mod_quiz'
* @param string $function the rest of the function name, e.g. 'cron' will end up calling 'mod_quiz_cron'
* @return mixed Complete function name to call if the callback exists or false if it doesn't.
* @throws coding_exception if invalid component specfied
*/
function component_callback_exists($component, $function) {
global $CFG; // This is needed for the inclusions.
$cleancomponent = clean_param($component, PARAM_COMPONENT);
if (empty($cleancomponent)) {
@ -7250,21 +7275,15 @@ function component_callback($component, $function, array $params = array(), $def
if (!function_exists($function) and function_exists($oldfunction)) {
if ($type !== 'mod' and $type !== 'core') {
debugging("Please use new function name $function instead of legacy $oldfunction");
debugging("Please use new function name $function instead of legacy $oldfunction", DEBUG_DEVELOPER);
}
$function = $oldfunction;
}
if (function_exists($function)) {
// Function exists, so just return function result.
$ret = call_user_func_array($function, $params);
if (is_null($ret)) {
return $default;
} else {
return $ret;
}
return $function;
}
return $default;
return false;
}
/**