From 1aa4940de749c42989c69e3f2f7d528ca7427168 Mon Sep 17 00:00:00 2001 From: Siebrand Mazeland Date: Mon, 17 Jun 2013 16:33:52 +0200 Subject: [PATCH] Update docs and type hints Change-Id: I6c513265d7e3136c43c160b86a83a921defaa3ec --- ResourceLoaderULSModule.php | 3 +++ UniversalLanguageSelector.hooks.php | 15 +++++++++------ UniversalLanguageSelector.php | 1 + 3 files changed, 13 insertions(+), 6 deletions(-) diff --git a/ResourceLoaderULSModule.php b/ResourceLoaderULSModule.php index 784db4f5..895b06da 100644 --- a/ResourceLoaderULSModule.php +++ b/ResourceLoaderULSModule.php @@ -23,6 +23,9 @@ * Resource loader module for providing MediaWiki language names. */ class ResourceLoaderULSModule extends ResourceLoaderModule { + /** + * @var Language + */ protected $language; protected $targets = array( 'desktop', 'mobile' ); diff --git a/UniversalLanguageSelector.hooks.php b/UniversalLanguageSelector.hooks.php index 6b0f8e50..468856b1 100644 --- a/UniversalLanguageSelector.hooks.php +++ b/UniversalLanguageSelector.hooks.php @@ -21,6 +21,8 @@ class UniversalLanguageSelectorHooks { /** * Whether ULS user toolbar (language selection and settings) is enabled. + * + * @param User $user * @return bool */ public static function isToolbarEnabled( $user ) { @@ -35,8 +37,8 @@ class UniversalLanguageSelectorHooks { } /** - * @param $out OutputPage - * @param $skin Skin + * @param OutputPage $out + * @param Skin $skin * @return bool * Hook: BeforePageDisplay */ @@ -64,7 +66,7 @@ class UniversalLanguageSelectorHooks { /** * @param $testModules array of javascript testing modules. 'qunit' is fed * using tests/qunit/QUnitTestResources.php. - * @param $resourceLoader ResourceLoader + * @param ResourceLoader $resourceLoader * @return bool * Hook: ResourceLoaderTestModules */ @@ -158,8 +160,9 @@ class UniversalLanguageSelectorHooks { /** * Hook to UserGetLanguageObject - * @param $user User - * @param $code String + * @param User $user + * @param string $code + * @param RequestContext $context Optional RequestContext * @return bool */ public static function getLanguage( $user, &$code, $context = null ) { @@ -239,7 +242,7 @@ class UniversalLanguageSelectorHooks { /** * Hook: ResourceLoaderGetConfigVars - * @param $vars Array + * @param array $vars * @return bool */ public static function addConfig( &$vars ) { diff --git a/UniversalLanguageSelector.php b/UniversalLanguageSelector.php index 3583b399..069fe7d9 100644 --- a/UniversalLanguageSelector.php +++ b/UniversalLanguageSelector.php @@ -146,6 +146,7 @@ $wgExtensionFunctions[] = function() { if ( $wgULSGeoService === true ) { $wgHooks['BeforePageDisplay'][] = function( &$out ) { + /** @var OutputPage $out */ $out->addScript( '' ); return true; };