DeprecatedHooks.php

Go to the documentation of this file.

<?php
namespace MediaWiki\HookContainer;
 
use InvalidArgumentException;
 
class DeprecatedHooks {
 
    private $deprecatedHooks = [
        'AddNewAccount' => [ 'deprecatedVersion' => '1.27', 'silent' => true ],
        'ArticleEditUpdates' => [ 'deprecatedVersion' => '1.35' ],
        'ArticleEditUpdatesDeleteFromRecentchanges' => [ 'deprecatedVersion' => '1.35' ],
        'ArticleRevisionUndeleted' => [ 'deprecatedVersion' => '1.35' ],
        'ArticleRollbackComplete' => [ 'deprecatedVersion' => '1.35' ],
        'BaseTemplateAfterPortlet' => [ 'deprecatedVersion' => '1.35', 'silent' => true ],
        'BaseTemplateToolbox' => [ 'deprecatedVersion' => '1.35' ],
        'BeforeHttpsRedirect' => [ 'deprecatedVersion' => '1.35' ],
        'BeforeParserrenderImageGallery' => [ 'deprecatedVersion' => '1.35' ],
        'CanIPUseHTTPS' => [ 'deprecatedVersion' => '1.35' ],
        'DiffRevisionTools' => [ 'deprecatedVersion => 1.35' ],
        'DiffViewHeader' => [ 'deprecatedVersion' => '1.35' ],
        'HistoryRevisionTools' => [ 'deprecatedVersion => 1.35' ],
        'InternalParseBeforeSanitize' => [ 'deprecatedVersion' => '1.35' ],
        'MagicWordwgVariableIDs' => [ 'deprecatedVersion' => '1.35', 'silent' => true ],
        'NewRevisionFromEditComplete' => [ 'deprecatedVersion' => '1.35' ],
        'PageContentInsertComplete' => [ 'deprecatedVersion' => '1.35' ],
        'PageContentSave' => [ 'deprecatedVersion' => '1.35', 'silent' => true ],
        'PageContentSaveComplete' => [ 'deprecatedVersion' => '1.35' ],
        'ParserFetchTemplate' => [ 'deprecatedVersion' => '1.35' ],
        'ParserGetVariableValueVarCache' => [ 'deprecatedVersion' => '1.35' ],
        'ParserSectionCreate' => [ 'deprecatedVersion' => '1.35' ],
        'PrefixSearchBackend' => [ 'deprecatedVersion' => '1.27', 'silent' => true ],
        'ResourceLoaderTestModules' => [ 'deprecatedVersion' => '1.33' ],
        'RevisionInsertComplete' => [ 'deprecatedVersion' => '1.31' ],
        'RollbackComplete' => [ 'deprecatedVersion' => '1.36', 'silent' => true ],
        'SecondaryDataUpdates' => [ 'deprecatedVersion' => '1.32', 'silent' => true ],
        'SpecialMuteSubmit' => [ 'deprecatedVersion' => '1.35', 'silent' => true ],
        'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink' => [ 'deprecatedVersion' => '1.35' ],
        'SkinTemplateOutputPageBeforeExec' => [ 'deprecatedVersion' => '1.35' ],
        'SkinTemplatePreventOtherActiveTabs' => [ 'deprecatedVersion' => '1.35' ],
        'SkinTemplateTabAction' => [ 'deprecatedVersion' => '1.35' ],
        'SkinTemplateToolboxEnd' => [ 'deprecatedVersion' => '1.35' ],
        'TitleMoveComplete' => [ 'deprecatedVersion' => '1.35' ],
        'TitleMoveCompleting' => [ 'deprecatedVersion' => '1.35' ],
        'UndeleteShowRevision' => [ 'deprecatedVersion' => '1.35' ],
        'UserRequiresHTTPS' => [ 'deprecatedVersion' => '1.35' ],
        'UserRetrieveNewTalks' => [ 'deprecatedVersion' => '1.35' ],
        'UserSetCookies' => [ 'deprecatedVersion' => '1.27' ],
        'WikiPageDeletionUpdates' => [ 'deprecatedVersion' => '1.32', 'silent' => true ],
    ];
 
    public function __construct( array $deprecatedHooks = [] ) {
        foreach ( $deprecatedHooks as $hook => $info ) {
            $this->markDeprecated(
                $hook,
                $info['deprecatedVersion'],
                $info['component'] ?? false,
                $info['silent'] ?? false
            );
        }
    }
 
    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;
    }
 
    public function isHookDeprecated( string $hook ) : bool {
        return isset( $this->deprecatedHooks[$hook] );
    }
 
    public function getDeprecationInfo( ?string $hook = null ) : ?array {
        if ( !$hook ) {
            return $this->deprecatedHooks;
        }
        return $this->deprecatedHooks[$hook] ?? null;
    }
}