Preferences.php

Go to the documentation of this file.

<?php
use MediaWiki\Auth\AuthManager;
use MediaWiki\MediaWikiServices;
use MediaWiki\Preferences\DefaultPreferencesFactory;
 
class Preferences {
 
    protected static function getDefaultPreferencesFactory() {
        global $wgContLang;
        $authManager = AuthManager::singleton();
        $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
        $config = MediaWikiServices::getInstance()->getMainConfig();
        $preferencesFactory = new DefaultPreferencesFactory(
            $config, $wgContLang, $authManager, $linkRenderer
        );
        return $preferencesFactory;
    }
 
    public static function getSaveBlacklist() {
        throw new Exception( __METHOD__ . '() is deprecated and does nothing' );
    }
 
    public static function getPreferences( $user, IContextSource $context ) {
        $preferencesFactory = self::getDefaultPreferencesFactory();
        return $preferencesFactory->getFormDescriptor( $user, $context );
    }
 
    public static function loadPreferenceValues( $user, $context, &$defaultPreferences ) {
        throw new Exception( __METHOD__ . '() is deprecated and does nothing' );
    }
 
    public static function getOptionFromUser( $name, $info, $user ) {
        throw new Exception( __METHOD__ . '() is deprecated and does nothing' );
    }
 
    public static function profilePreferences(
        $user, IContextSource $context, &$defaultPreferences
    ) {
        wfDeprecated( __METHOD__, '1.31' );
        $defaultPreferences = self::getPreferences( $user, $context );
    }
 
    public static function skinPreferences( $user, IContextSource $context, &$defaultPreferences ) {
        wfDeprecated( __METHOD__, '1.31' );
        $defaultPreferences = self::getPreferences( $user, $context );
    }
 
    public static function filesPreferences(
        $user, IContextSource $context, &$defaultPreferences
    ) {
        wfDeprecated( __METHOD__, '1.31' );
        $defaultPreferences = self::getPreferences( $user, $context );
    }
 
    public static function datetimePreferences(
        $user, IContextSource $context, &$defaultPreferences
    ) {
        wfDeprecated( __METHOD__, '1.31' );
        $defaultPreferences = self::getPreferences( $user, $context );
    }
 
    public static function renderingPreferences(
        $user, IContextSource $context, &$defaultPreferences
    ) {
        wfDeprecated( __METHOD__, '1.31' );
        $defaultPreferences = self::getPreferences( $user, $context );
    }
 
    public static function editingPreferences(
        $user, IContextSource $context, &$defaultPreferences
    ) {
        wfDeprecated( __METHOD__, '1.31' );
        $defaultPreferences = self::getPreferences( $user, $context );
    }
 
    public static function rcPreferences( $user, IContextSource $context, &$defaultPreferences ) {
        wfDeprecated( __METHOD__, '1.31' );
        $defaultPreferences = self::getPreferences( $user, $context );
    }
 
    public static function watchlistPreferences(
        $user, IContextSource $context, &$defaultPreferences
    ) {
        wfDeprecated( __METHOD__, '1.31' );
        $defaultPreferences = self::getPreferences( $user, $context );
    }
 
    public static function searchPreferences(
        $user, IContextSource $context, &$defaultPreferences
    ) {
        wfDeprecated( __METHOD__, '1.31' );
        $defaultPreferences = self::getPreferences( $user, $context );
    }
 
    public static function miscPreferences( $user, IContextSource $context, &$defaultPreferences ) {
    }
 
    public static function generateSkinOptions( $user, IContextSource $context ) {
        wfDeprecated( __METHOD__, '1.31' );
        return self::getPreferences( $user, $context );
    }
 
    static function getDateOptions( IContextSource $context ) {
        throw new Exception( __METHOD__ . '() is deprecated and does nothing' );
    }
 
    public static function getImageSizes( IContextSource $context ) {
        throw new Exception( __METHOD__ . '() is deprecated and does nothing' );
    }
 
    public static function getThumbSizes( IContextSource $context ) {
        throw new Exception( __METHOD__ . '() is deprecated and does nothing' );
    }
 
    public static function validateSignature( $signature, $alldata, $form ) {
        throw new Exception( __METHOD__ . '() is deprecated and does nothing' );
    }
 
    public static function cleanSignature( $signature, $alldata, $form ) {
        throw new Exception( __METHOD__ . '() is deprecated and does nothing now' );
    }
 
    public static function getFormObject(
        $user,
        IContextSource $context,
        $formClass = PreferencesForm::class,
        array $remove = []
    ) {
        $preferencesFactory = self::getDefaultPreferencesFactory();
        return $preferencesFactory->getForm( $user, $context, $formClass, $remove );
    }
 
    public static function getTimezoneOptions( IContextSource $context ) {
        throw new Exception( __METHOD__ . '() is deprecated and does nothing' );
    }
 
    public static function filterIntval( $value, $alldata ) {
        throw new Exception( __METHOD__ . '() is deprecated and does nothing' );
    }
 
    public static function filterTimezoneInput( $tz, $alldata ) {
        throw new Exception( __METHOD__ . '() is deprecated and does nothing' );
    }
 
    public static function tryFormSubmit( $formData, $form ) {
        $preferencesFactory = self::getDefaultPreferencesFactory();
        return $preferencesFactory->legacySaveFormData( $formData, $form );
    }
 
    public static function tryUISubmit( $formData, $form ) {
        $preferencesFactory = self::getDefaultPreferencesFactory();
        return $preferencesFactory->legacySubmitForm( $formData, $form );
    }
 
    public static function getTimeZoneList( Language $language ) {
        throw new Exception( __METHOD__ . '() is deprecated and does nothing' );
    }
}