diff options
author | Pierre Schmitz <pierre@archlinux.de> | 2006-10-11 18:12:39 +0000 |
---|---|---|
committer | Pierre Schmitz <pierre@archlinux.de> | 2006-10-11 18:12:39 +0000 |
commit | 183851b06bd6c52f3cae5375f433da720d410447 (patch) | |
tree | a477257decbf3360127f6739c2f9d0ec57a03d39 /includes/Hooks.php |
MediaWiki 1.7.1 wiederhergestellt
Diffstat (limited to 'includes/Hooks.php')
-rw-r--r-- | includes/Hooks.php | 131 |
1 files changed, 131 insertions, 0 deletions
diff --git a/includes/Hooks.php b/includes/Hooks.php new file mode 100644 index 00000000..4daffaf3 --- /dev/null +++ b/includes/Hooks.php @@ -0,0 +1,131 @@ +<?php +/** + * Hooks.php -- a tool for running hook functions + * Copyright 2004, 2005 Evan Prodromou <evan@wikitravel.org>. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + * + * @author Evan Prodromou <evan@wikitravel.org> + * @package MediaWiki + * @see hooks.txt + */ + + +/** + * Because programmers assign to $wgHooks, we need to be very + * careful about its contents. So, there's a lot more error-checking + * in here than would normally be necessary. + */ +function wfRunHooks($event, $args = null) { + + global $wgHooks; + $fname = 'wfRunHooks'; + + if (!is_array($wgHooks)) { + throw new MWException("Global hooks array is not an array!\n"); + return false; + } + + if (!array_key_exists($event, $wgHooks)) { + return true; + } + + if (!is_array($wgHooks[$event])) { + throw new MWException("Hooks array for event '$event' is not an array!\n"); + return false; + } + + foreach ($wgHooks[$event] as $index => $hook) { + + $object = NULL; + $method = NULL; + $func = NULL; + $data = NULL; + $have_data = false; + + /* $hook can be: a function, an object, an array of $function and $data, + * an array of just a function, an array of object and method, or an + * array of object, method, and data. + */ + + if (is_array($hook)) { + if (count($hook) < 1) { + throw new MWException("Empty array in hooks for " . $event . "\n"); + } else if (is_object($hook[0])) { + $object =& $wgHooks[$event][$index][0]; + if (count($hook) < 2) { + $method = "on" . $event; + } else { + $method = $hook[1]; + if (count($hook) > 2) { + $data = $hook[2]; + $have_data = true; + } + } + } else if (is_string($hook[0])) { + $func = $hook[0]; + if (count($hook) > 1) { + $data = $hook[1]; + $have_data = true; + } + } else { + var_dump( $wgHooks ); + throw new MWException("Unknown datatype in hooks for " . $event . "\n"); + } + } else if (is_string($hook)) { # functions look like strings, too + $func = $hook; + } else if (is_object($hook)) { + $object =& $wgHooks[$event][$index]; + $method = "on" . $event; + } else { + throw new MWException("Unknown datatype in hooks for " . $event . "\n"); + } + + /* We put the first data element on, if needed. */ + + if ($have_data) { + $hook_args = array_merge(array($data), $args); + } else { + $hook_args = $args; + } + + + if ( isset( $object ) ) { + $func = get_class( $object ) . '::' . $method; + } + + /* Call the hook. */ + wfProfileIn( $func ); + if( isset( $object ) ) { + $retval = call_user_func_array(array(&$object, $method), $hook_args); + } else { + $retval = call_user_func_array($func, $hook_args); + } + wfProfileOut( $func ); + + /* String return is an error; false return means stop processing. */ + + if (is_string($retval)) { + global $wgOut; + $wgOut->showFatalError($retval); + return false; + } else if (!$retval) { + return false; + } + } + + return true; +} +?> |