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
|
<?php
/**
* Holds list of deprecated hooks and methods for retrieval
*
* 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.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\HookContainer;
use InvalidArgumentException;
class DeprecatedHooks {
/**
* @var array[] List of deprecated hooks. Value arrays for each hook contain:
* - deprecatedVersion: (string) Version in which the hook was deprecated,
* to pass to wfDeprecated().
* - component: (string, optional) $component to pass to wfDeprecated().
* - silent (bool, optional) If true, no deprecation warning will be raised
*/
private $deprecatedHooks = [
'AddNewAccount' => [ 'deprecatedVersion' => '1.27', 'silent' => true ],
'BaseTemplateAfterPortlet' => [ 'deprecatedVersion' => '1.35' ],
'BeforeParserFetchTemplateAndtitle' => [ 'deprecatedVersion' => '1.36' ],
'BeforeParserrenderImageGallery' => [ 'deprecatedVersion' => '1.35' ],
'EditPageBeforeEditToolbar' => [ 'deprecatedVersion' => '1.36' ],
'InternalParseBeforeSanitize' => [ 'deprecatedVersion' => '1.35' ],
'LinksUpdateConstructed' => [ 'deprecatedVersion' => '1.38' ],
'LinksUpdateAfterInsert' => [ 'deprecatedVersion' => '1.38' ],
'LocalFile::getHistory' => [ 'deprecatedVersion' => '1.37' ],
'MagicWordwgVariableIDs' => [ 'deprecatedVersion' => '1.35', 'silent' => true ],
'PageContentSave' => [ 'deprecatedVersion' => '1.35', 'silent' => true ],
'ParserSectionCreate' => [ 'deprecatedVersion' => '1.35' ],
'ParserTestTables' => [ 'deprecatedVersion' => '1.36', 'silent' => true ],
'PrefixSearchBackend' => [ 'deprecatedVersion' => '1.27', 'silent' => true ],
'ProtectionForm::buildForm' => [ 'deprecatedVersion' => '1.36', 'silent' => true ],
'ResourceLoaderTestModules' => [ 'deprecatedVersion' => '1.33' ],
'RollbackComplete' => [ 'deprecatedVersion' => '1.36', 'silent' => true ],
'SpecialMuteSubmit' => [ 'deprecatedVersion' => '1.35', 'silent' => true ],
'UserLoadFromDatabase' => [ 'deprecatedVersion' => '1.37' ],
'UserSetCookies' => [ 'deprecatedVersion' => '1.27' ],
'WikiPageDeletionUpdates' => [ 'deprecatedVersion' => '1.32', 'silent' => true ],
'userCan' => [ 'deprecatedVersion' => '1.37' ],
'ArticleDelete' => [ 'deprecatedVersion' => '1.37', 'silent' => true ],
'ArticleDeleteComplete' => [ 'deprecatedVersion' => '1.37', 'silent' => true ],
'SkinTemplateNavigation' => [ 'deprecatedVersion' => '1.39' ],
'SkinTemplateNavigation::SpecialPage' => [ 'deprecatedVersion' => '1.39' ],
'PersonalUrls' => [ 'deprecatedVersion' => '1.39' ],
];
/**
* @param array[] $deprecatedHooks List of hooks to mark as deprecated.
* Value arrays for each hook contain:
* - deprecatedVersion: (string) Version in which the hook was deprecated,
* to pass to wfDeprecated().
* - component: (string, optional) $component to pass to wfDeprecated().
* - silent: (bool, optional) True to not raise any deprecation warning
*/
public function __construct( array $deprecatedHooks = [] ) {
foreach ( $deprecatedHooks as $hook => $info ) {
$this->markDeprecated(
$hook,
$info['deprecatedVersion'],
$info['component'] ?? false,
$info['silent'] ?? false
);
}
}
/**
* For use by extensions, to add to list of deprecated hooks.
* Core-defined hooks should instead be added to $this->$deprecatedHooks directly.
* However, the preferred method of marking a hook deprecated is by adding it to
* the DeprecatedHooks attribute in extension.json
*
* @param string $hook
* @param string $version Version in which the hook was deprecated, to pass to wfDeprecated()
* @param string|null $component (optional) component to pass to wfDeprecated().
* @param bool $silent True to not raise any deprecation warning
* @throws InvalidArgumentException Hook has already been marked deprecated
*/
public function markDeprecated(
string $hook, string $version, ?string $component = null, bool $silent = false
): void {
if ( isset( $this->deprecatedHooks[$hook] ) ) {
throw new InvalidArgumentException(
"Cannot mark hook '$hook' deprecated with version $version. " .
"It is already marked deprecated with version " .
$this->deprecatedHooks[$hook]['deprecatedVersion']
);
}
$hookInfo = [
'deprecatedVersion' => $version,
'silent' => $silent
];
if ( $component ) {
$hookInfo['component'] = $component;
}
$this->deprecatedHooks[$hook] = $hookInfo;
}
/**
* Checks whether hook is marked deprecated
* @param string $hook Hook name
* @return bool
*/
public function isHookDeprecated( string $hook ): bool {
return isset( $this->deprecatedHooks[$hook] );
}
/**
* Gets deprecation info for a specific hook or all hooks if hook not specified
* @param string|null $hook (optional) Hook name
* @return array|null Value array from $this->deprecatedHooks for a specific hook or all hooks
*/
public function getDeprecationInfo( ?string $hook = null ): ?array {
if ( !$hook ) {
return $this->deprecatedHooks;
}
return $this->deprecatedHooks[$hook] ?? null;
}
}
|
