From: Thiemo Mättig <thiemo.maettig@wikimedia.de>
Date: Mon, 17 Apr 2017 20:31:22 +0000 (+0200)
Subject: Use more specific string[] type hint for language variants
X-Git-Tag: 1.31.0-rc.0~3481^2
X-Git-Url: http://git.cyclocoop.org/%22%20.%20generer_url_ecrire%28%22suivi_revisions%22%2C%22id_auteur=%24connecte%22%29%20.%20%22?a=commitdiff_plain;h=8bbf6cb2ebb25dbeb15026b954027b16eef29874;p=lhc%2Fweb%2Fwiklou.git

Use more specific string[] type hint for language variants

This patch only touches PHPDoc documentation, nothing else.

Change-Id: Ia79d06425a3b8629c171cd68ae435c64dac86f46
---

diff --git a/languages/FakeConverter.php b/languages/FakeConverter.php
index 78019a7882..6f2117c626 100644
--- a/languages/FakeConverter.php
+++ b/languages/FakeConverter.php
@@ -64,6 +64,9 @@ class FakeConverter {
 		return $this->mLang->getFormattedNsText( $ns );
 	}
 
+	/**
+	 * @return string[]
+	 */
 	function getVariants() {
 		return [ $this->mLang->getCode() ];
 	}
diff --git a/languages/Language.php b/languages/Language.php
index 067231557b..14e6f5c63b 100644
--- a/languages/Language.php
+++ b/languages/Language.php
@@ -4127,7 +4127,7 @@ class Language {
 	 * Get the list of variants supported by this language
 	 * see sample implementation in LanguageZh.php
 	 *
-	 * @return array An array of language codes
+	 * @return string[] An array of language codes
 	 */
 	public function getVariants() {
 		return $this->mConverter->getVariants();
diff --git a/languages/LanguageConverter.php b/languages/LanguageConverter.php
index 6286a2b062..4c3e5be207 100644
--- a/languages/LanguageConverter.php
+++ b/languages/LanguageConverter.php
@@ -48,6 +48,10 @@ class LanguageConverter {
 	];
 
 	public $mMainLanguageCode;
+
+	/**
+	 * @var string[]
+	 */
 	public $mVariants;
 	public $mVariantFallbacks;
 	public $mVariantNames;
@@ -75,11 +79,9 @@ class LanguageConverter {
 	const CACHE_VERSION_KEY = 'VERSION 7';
 
 	/**
-	 * Constructor
-	 *
 	 * @param Language $langobj
 	 * @param string $maincode The main language code of this language
-	 * @param array $variants The supported variants of this language
+	 * @param string[] $variants The supported variants of this language
 	 * @param array $variantfallbacks The fallback language of each variant
 	 * @param array $flags Defining the custom strings that maps to the flags
 	 * @param array $manualLevel Limit for supported variants
@@ -122,7 +124,7 @@ class LanguageConverter {
 	 * Get all valid variants.
 	 * Call this instead of using $this->mVariants directly.
 	 *
-	 * @return array Contains all valid variants
+	 * @return string[] Contains all valid variants
 	 */
 	public function getVariants() {
 		return $this->mVariants;