1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
<?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>
* @see hooks.txt
* @file
*/
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\MediaWikiServices;
/**
* Hooks class.
*
* Legacy wrapper for HookContainer
* Please use HookContainer instead.
*
* @since 1.18
*/
class Hooks {
/**
* Attach an event handler to a given hook in both legacy and non-legacy hook systems
*
* @param string $name Name of hook
* @param callable $callback Callback function to attach
* @deprecated since 1.35. use HookContainer::register() instead
* @since 1.18
*/
public static function register( $name, $callback ) {
if ( !defined( 'MW_SERVICE_BOOTSTRAP_COMPLETE' ) ) {
wfDeprecatedMsg( 'Registering handler for ' . $name .
' before MediaWiki bootstrap complete was deprecated in MediaWiki 1.35',
'1.35' );
}
$hookContainer = MediaWikiServices::getInstance()->getHookContainer();
$hookContainer->register( $name, $callback );
}
/**
* Clears hooks registered via Hooks::register(). Does not touch $wgHooks.
* This is intended for use while testing and will fail if MW_PHPUNIT_TEST is not defined.
*
* @param string $name The name of the hook to clear.
*
* @since 1.21
* @deprecated since 1.35. Instead of using Hooks::register() and Hooks::clear(),
* use HookContainer::scopedRegister() instead to register a temporary hook
* @throws MWException If not in testing mode.
* @codeCoverageIgnore
*/
public static function clear( $name ) {
wfDeprecated( __METHOD__, '1.35' );
if ( !defined( 'MW_PHPUNIT_TEST' ) && !defined( 'MW_PARSER_TEST' ) ) {
throw new MWException( 'Cannot reset hooks in operation.' );
}
$hookContainer = MediaWikiServices::getInstance()->getHookContainer();
$hookContainer->clear( $name );
}
/**
* Returns true if a hook has a function registered to it.
* The function may have been registered either via Hooks::register or in $wgHooks.
*
* @since 1.18
* @deprecated since 1.35. use HookContainer::isRegistered() instead
* @param string $name Name of hook
* @return bool True if the hook has a function registered to it
*/
public static function isRegistered( $name ) {
$hookContainer = MediaWikiServices::getInstance()->getHookContainer();
return $hookContainer->isRegistered( $name );
}
/**
* Returns an array of all the event functions attached to a hook
* This combines functions registered via Hooks::register and with $wgHooks.
*
* @since 1.18
* @deprecated since 1.35
* @param string $name Name of the hook
* @return array
*/
public static function getHandlers( $name ) {
$hookContainer = MediaWikiServices::getInstance()->getHookContainer();
$handlers = $hookContainer->getLegacyHandlers( $name );
$funcName = 'on' . strtr( ucfirst( $name ), ':-', '__' );
foreach ( $hookContainer->getHandlers( $name ) as $obj ) {
$handlers[] = [ $obj, $funcName ];
}
return $handlers;
}
/**
* Call hook functions defined in Hooks::register and $wgHooks.
*
* For the given hook event, fetch the array of hook events and
* process them. Determine the proper callback for each hook and
* then call the actual hook using the appropriate arguments.
* Finally, process the return value and return/throw accordingly.
*
* For hook event that are not abortable through a handler's return value,
* use runWithoutAbort() instead.
*
* @param string $event Event name
* @param array $args Array of parameters passed to hook functions
* @param string|null $deprecatedVersion [optional] Mark hook as deprecated with version number
* @return bool True if no handler aborted the hook
*
* @throws Exception
* @since 1.22 A hook function is not required to return a value for
* processing to continue. Not returning a value (or explicitly
* returning null) is equivalent to returning true.
* @deprecated since 1.35 Use HookContainer::run() instead
*/
public static function run( $event, array $args = [], $deprecatedVersion = null ) {
$hookContainer = MediaWikiServices::getInstance()->getHookContainer();
$options = $deprecatedVersion ? [ 'deprecatedVersion' => $deprecatedVersion ] : [];
return $hookContainer->run( $event, $args, $options );
}
/**
* Call hook functions defined in Hooks::register and $wgHooks.
*
* @param string $event Event name
* @param array $args Array of parameters passed to hook functions
* @param string|null $deprecatedVersion [optional] Mark hook as deprecated with version number
* @return bool Always true
* @throws UnexpectedValueException callback returns an invalid value
* @since 1.30
* @deprecated since 1.35 Use HookContainer::run() with 'abortable' option instead
*/
public static function runWithoutAbort( $event, array $args = [], $deprecatedVersion = null ) {
$hookContainer = MediaWikiServices::getInstance()->getHookContainer();
$options = $deprecatedVersion ? [ 'deprecatedVersion' => $deprecatedVersion ] : [];
$options[ 'abortable' ] = false;
return $hookContainer->run( $event, $args, $options );
}
/**
* Get a HookRunner instance for calling hooks using the new interfaces.
*
* Classes using dependency injection should instead receive a HookContainer
* and construct a private HookRunner from it.
*
* Classes without dependency injection may alternatively use
* ProtectedHookAccessorTrait, a trait which provides getHookRunner() as a
* protected method.
*
* @since 1.35
*
* @return HookRunner
*/
public static function runner() {
return new HookRunner( MediaWikiServices::getInstance()->getHookContainer() );
}
}
|
