From: Jack Phoenix Date: Wed, 26 Jan 2011 16:50:31 +0000 (+0000) Subject: Hooks.php: trim trailing spaces, tweak docs, etc. X-Git-Tag: 1.31.0-rc.0~32351 X-Git-Url: https://git.heureux-cyclage.org/?p=lhc%2Fweb%2Fwiklou.git;a=commitdiff_plain;h=3f0decb5cd8b7066c3e5bea3058c20d32bb34102 Hooks.php: trim trailing spaces, tweak docs, etc. --- diff --git a/includes/Hooks.php b/includes/Hooks.php index 4ccae327c5..87c677dce9 100644 --- a/includes/Hooks.php +++ b/includes/Hooks.php @@ -4,26 +4,25 @@ * * Copyright 2004, 2005 Evan Prodromou . * - * 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 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. + * 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 + * 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 * @see hooks.txt * @file */ - /** * Call hook functions defined in $wgHooks * @@ -45,72 +44,58 @@ function hookErrorHandler( $errno, $errstr ) { class MWHookException extends MWException {} - /** * Hooks class. - * - * Used to supersede $wgHooks, because globals are EVIL. * + * Used to supersede $wgHooks, because globals are EVIL. */ class Hooks { - + protected static $handlers = array(); - + /** * Attach an event handler to a given hook - * - * @access public - * @param mixed $name Name of hook - * @param mixed $callback Callback function to attach + * + * @param $name Mixed: name of hook + * @param $callback Mixed: callback function to attach * @return void */ public static function register( $name, $callback ) { - if( !isset( self::$handlers[$name] ) ) { self::$handlers[$name] = array(); } - + self::$handlers[$name][] = $callback; - } - + /** * Returns true if a hook has a function registered to it. - * - * @access public - * @param mixed $name Name of hook - * @return bool + * + * @param $name Mixed: name of hook + * @return Boolean: true if a hook has a function registered to it */ public static function isRegistered( $name ) { - if( !isset( self::$handlers[$name] ) ) { self::$handlers[$name] = array(); } - + return ( count( self::$handlers[$name] ) != 0 ); - } - + /** * Returns an array of all the event functions attached to a hook - * - * @access public - * @param mixed $name Name of hook + * + * @param $name Mixed: name of the hook * @return array */ public static function getHandlers( $name ) { - if( !isset( self::$handlers[$name] ) ) { return array(); } - + return self::$handlers[$name]; - } - - - - + /** * Call hook functions defined in Hooks::register * @@ -123,33 +108,31 @@ class Hooks { * @return Boolean */ public static function run( $event, $args = array() ) { - global $wgHooks; - + // Return quickly in the most common case if ( !isset( self::$handlers[$event] ) && !isset( $wgHooks[$event] ) ) { return true; } - - if (!is_array(self::$handlers)) { - throw new MWException("Local hooks array is not an array!\n"); + + if ( !is_array( self::$handlers ) ) { + throw new MWException( "Local hooks array is not an array!\n" ); } - - if (!is_array($wgHooks)) { - throw new MWException("Global hooks array is not an array!\n"); + + if ( !is_array( $wgHooks ) ) { + throw new MWException( "Global hooks array is not an array!\n" ); } - + $new_handlers = (array) self::$handlers; $old_handlers = (array) $wgHooks; - + $hook_array = array_merge( $new_handlers, $old_handlers ); - - if ( !is_array($hook_array[$event]) ) { - throw new MWException("Hooks array for event '$event' is not an array!\n"); + + if ( !is_array( $hook_array[$event] ) ) { + throw new MWException( "Hooks array for event '$event' is not an array!\n" ); } - - foreach ($hook_array[$event] as $index => $hook) { - + + foreach ( $hook_array[$event] as $index => $hook ) { $object = null; $method = null; $func = null; @@ -157,16 +140,16 @@ class Hooks { $have_data = false; $closure = false; $badhookmsg = 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. + + /** + * $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] ) ) { + throw new MWException( 'Empty array in hooks for ' . $event . "\n" ); + } elseif ( is_object( $hook[0] ) ) { $object = $hook_array[$event][$index][0]; if ( $object instanceof Closure ) { $closure = true; @@ -176,7 +159,7 @@ class Hooks { } } else { if ( count( $hook ) < 2 ) { - $method = "on" . $event; + $method = 'on' . $event; } else { $method = $hook[1]; if ( count( $hook ) > 2 ) { @@ -185,18 +168,18 @@ class Hooks { } } } - } else if ( is_string( $hook[0] ) ) { + } elseif ( is_string( $hook[0] ) ) { $func = $hook[0]; if ( count( $hook ) > 1) { $data = $hook[1]; $have_data = true; } } else { - throw new MWException( "Unknown datatype in hooks for " . $event . "\n" ); + throw new MWException( 'Unknown datatype in hooks for ' . $event . "\n" ); } - } else if ( is_string( $hook ) ) { # functions look like strings, too + } elseif ( is_string( $hook ) ) { # functions look like strings, too $func = $hook; - } else if ( is_object( $hook ) ) { + } elseif ( is_object( $hook ) ) { $object = $hook_array[$event][$index]; if ( $object instanceof Closure ) { $closure = true; @@ -204,17 +187,16 @@ class Hooks { $method = "on" . $event; } } else { - throw new MWException( "Unknown datatype in hooks for " . $event . "\n" ); + 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); + $hook_args = array_merge( array( $data ), $args ); } else { $hook_args = $args; } - + if ( $closure ) { $callback = $object; $func = "hook-$event-closure"; @@ -226,11 +208,12 @@ class Hooks { } else { $callback = $func; } - + // Run autoloader (workaround for call_user_func_array bug) is_callable( $callback ); - - /* Call the hook. The documentation of call_user_func_array clearly + + /** + * Call the hook. The documentation of call_user_func_array clearly * states that FALSE is returned on failure. However this is not * case always. In some version of PHP if the function signature * does not match the call signature, PHP will issue an warning: @@ -240,7 +223,7 @@ class Hooks { * catches that warning and provides better error message. The * function documentation also says that: * In other words, it does not depend on the function signature - * whether the parameter is passed by a value or by a reference. + * whether the parameter is passed by a value or by a reference. * There is also PHP bug http://bugs.php.net/bug.php?id=47554 which * is unsurprisingly marked as bogus. In short handling of failures * with call_user_func_array is a failure, the documentation for that @@ -257,7 +240,7 @@ class Hooks { } wfProfileOut( $func ); restore_error_handler(); - + /* String return is an error; false return means stop processing. */ if ( is_string( $retval ) ) { global $wgOut; @@ -277,22 +260,32 @@ class Hooks { $prettyFunc = strval( $callback ); } if ( $badhookmsg ) { - throw new MWException( "Detected bug in an extension! " . - "Hook $prettyFunc has invalid call signature; " . $badhookmsg ); + throw new MWException( + 'Detected bug in an extension! ' . + "Hook $prettyFunc has invalid call signature; " . $badhookmsg + ); } else { - throw new MWException( "Detected bug in an extension! " . + throw new MWException( + 'Detected bug in an extension! ' . "Hook $prettyFunc failed to return a value; " . - "should return true to continue hook processing or false to abort." ); + 'should return true to continue hook processing or false to abort.' + ); } } else if ( !$retval ) { return false; } } - + return true; } - - //This REALLY should be protected... but it's public for compatibility + + /** + * This REALLY should be protected... but it's public for compatibility + * + * @param $errno Unused + * @param $errstr String: error message + * @return Boolean: false + */ public static function hookErrorHandler( $errno, $errstr ) { if ( strpos( $errstr, 'expected to be a reference, value given' ) !== false ) { throw new MWHookException( $errstr );