Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00% covered (success)
100.00%
24 / 24
100.00% covered (success)
100.00%
4 / 4
 CRAP
100.00% covered (success)
100.00%
1 / 1
DeprecatedHooks
100.00% covered (success)
100.00%
24 / 24
100.00% covered (success)
100.00%
4 / 4
 8
100.00% covered (success)
100.00%
1 / 1
 __construct
100.00% covered (success)
100.00%
7 / 7
100.00% covered (success)
100.00%
1 / 1
 2
 markDeprecated
100.00% covered (success)
100.00%
13 / 13
100.00% covered (success)
100.00%
1 / 1
 3
 isHookDeprecated
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
 1
 getDeprecationInfo
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
1 / 1
 2
1<?php
2/**
3 * Holds list of deprecated hooks and methods for retrieval
4 *
5 * @license GPL-2.0-or-later
6 * @file
7 */
8
9namespace MediaWiki\HookContainer;
10
11use InvalidArgumentException;
12
13class DeprecatedHooks {
14
15    /**
16     * @var array[] List of deprecated hooks. Value arrays for each hook contain:
17     *  - deprecatedVersion: (string) Version in which the hook was deprecated,
18     *    to pass to wfDeprecated().
19     *  - component: (string, optional) $component to pass to wfDeprecated().
20     *  - silent (bool, optional) If true, no deprecation warning will be raised
21     * @phpcs-require-sorted-array
22     */
23    private $deprecatedHooks = [
24        'ArticleDelete' => [ 'deprecatedVersion' => '1.37', 'silent' => true ],
25        'ArticleDeleteComplete' => [ 'deprecatedVersion' => '1.37', 'silent' => true ],
26        'ArticleUndelete' => [ 'deprecatedVersion' => '1.40', 'silent' => true ],
27        'AutopromoteCondition' => [ 'deprecatedVersion' => '1.46' ],
28        'EditPageBeforeEditToolbar' => [ 'deprecatedVersion' => '1.36' ],
29        'EmailUser' => [ 'deprecatedVersion' => '1.41', 'silent' => true ],
30        'EmailUserPermissionsErrors' => [ 'deprecatedVersion' => '1.41' ],
31        'InterwikiLoadPrefix' => [ 'deprecatedVersion' => '1.36' ],
32        'LocalFile::getHistory' => [ 'deprecatedVersion' => '1.37' ],
33        'MessageCache::get' => [ 'deprecatedVersion' => '1.41' ],
34        'PrefixSearchBackend' => [ 'deprecatedVersion' => '1.27' ],
35        'ProtectionForm::buildForm' => [ 'deprecatedVersion' => '1.36', 'silent' => true ],
36        'RecentChangesPurgeRows' => [ 'deprecatedVersion' => '1.45', 'silent' => true ],
37        'RollbackComplete' => [ 'deprecatedVersion' => '1.36', 'silent' => true ],
38        'SearchDataForIndex' => [ 'deprecatedVersion' => '1.40', 'silent' => true ],
39        'userCan' => [ 'deprecatedVersion' => '1.37' ],
40        'UserCanSendEmail' => [ 'deprecatedVersion' => '1.41', 'silent' => true ],
41        'WatchedItemQueryServiceExtensionsHook' => [ 'deprecatedVersion' => '1.46' ],
42        'WikiPageDeletionUpdates' => [ 'deprecatedVersion' => '1.32', 'silent' => true ],
43    ];
44
45    /**
46     * @param array[] $deprecatedHooks List of hooks to mark as deprecated.
47     * Value arrays for each hook contain:
48     *  - deprecatedVersion: (string) Version in which the hook was deprecated,
49     *    to pass to wfDeprecated().
50     *  - component: (string, optional) $component to pass to wfDeprecated().
51     *  - silent: (bool, optional) True to not raise any deprecation warning
52     */
53    public function __construct( array $deprecatedHooks = [] ) {
54        foreach ( $deprecatedHooks as $hook => $info ) {
55            $this->markDeprecated(
56                $hook,
57                $info['deprecatedVersion'],
58                $info['component'] ?? false,
59                $info['silent'] ?? false
60            );
61        }
62    }
63
64    /**
65     * For use by extensions, to add to list of deprecated hooks.
66     * Core-defined hooks should instead be added to $this->$deprecatedHooks directly.
67     * However, the preferred method of marking a hook deprecated is by adding it to
68     * the DeprecatedHooks attribute in extension.json
69     *
70     * @param string $hook
71     * @param string $version Version in which the hook was deprecated, to pass to wfDeprecated()
72     * @param string|null $component (optional) component to pass to wfDeprecated().
73     * @param bool $silent True to not raise any deprecation warning
74     * @throws InvalidArgumentException Hook has already been marked deprecated
75     */
76    public function markDeprecated(
77        string $hook, string $version, ?string $component = null, bool $silent = false
78    ): void {
79        if ( isset( $this->deprecatedHooks[$hook] ) ) {
80            throw new InvalidArgumentException(
81                "Cannot mark hook '$hook' deprecated with version $version. " .
82                "It is already marked deprecated with version " .
83                $this->deprecatedHooks[$hook]['deprecatedVersion']
84            );
85        }
86        $hookInfo = [
87            'deprecatedVersion' => $version,
88            'silent' => $silent
89        ];
90        if ( $component ) {
91            $hookInfo['component'] = $component;
92        }
93        $this->deprecatedHooks[$hook] = $hookInfo;
94    }
95
96    /**
97     * Checks whether hook is marked deprecated
98     * @param string $hook Hook name
99     * @return bool
100     */
101    public function isHookDeprecated( string $hook ): bool {
102        return isset( $this->deprecatedHooks[$hook] );
103    }
104
105    /**
106     * Gets deprecation info for a specific hook or all hooks if hook not specified
107     * @param string|null $hook (optional) Hook name
108     * @return array|null Value array from $this->deprecatedHooks for a specific hook or all hooks
109     */
110    public function getDeprecationInfo( ?string $hook = null ): ?array {
111        if ( !$hook ) {
112            return $this->deprecatedHooks;
113        }
114        return $this->deprecatedHooks[$hook] ?? null;
115    }
116}