From 1af3e211eb26f41f3aed2583553c934b4d630ff9 Mon Sep 17 00:00:00 2001 From: Umherirrender Date: Thu, 12 Jan 2023 19:04:20 +0100 Subject: [PATCH] docs: Add missing StubUserLang type to some @param/@return Change-Id: Ic1f192c7a21e529113fd7d537a79b2e4f8983b9c --- includes/Status.php | 6 +++--- includes/diff/DifferenceEngine.php | 5 +++-- includes/gallery/ImageGalleryBase.php | 3 ++- includes/language/MessageCache.php | 3 ++- includes/parser/Parser.php | 2 +- includes/title/Title.php | 2 +- 6 files changed, 12 insertions(+), 9 deletions(-) diff --git a/includes/Status.php b/includes/Status.php index 933d93ba53d..5e5fa10bddb 100644 --- a/includes/Status.php +++ b/includes/Status.php @@ -289,7 +289,7 @@ class Status extends StatusValue { * If $error is an array, the "params" field is a list of parameters for the message. * * @param array|string $error Code string or (key: code string, params: string[]) map - * @param string|Language|null $lang Language to use for processing messages + * @param string|Language|StubUserLang|null $lang Language to use for processing messages * @return Message */ protected function getErrorMessage( $error, $lang = null ) { @@ -324,7 +324,7 @@ class Status extends StatusValue { * @param string|false $shortContext A short enclosing context message name, to * be used when there is a single error * @param string|false $longContext A long enclosing context message name, for a list - * @param string|Language|null $lang Language to use for processing messages + * @param string|Language|StubUserLang|null $lang Language to use for processing messages * @return string */ public function getHTML( $shortContext = false, $longContext = false, $lang = null ) { @@ -339,7 +339,7 @@ class Status extends StatusValue { /** * Return an array with a Message object for each error. * @param array $errors - * @param string|Language|null $lang Language to use for processing messages + * @param string|Language|StubUserLang|null $lang Language to use for processing messages * @return Message[] */ protected function getErrorMessageArray( $errors, $lang = null ) { diff --git a/includes/diff/DifferenceEngine.php b/includes/diff/DifferenceEngine.php index 964115da9a3..5d2d41d25bf 100644 --- a/includes/diff/DifferenceEngine.php +++ b/includes/diff/DifferenceEngine.php @@ -36,6 +36,7 @@ use MediaWiki\Revision\RevisionRecord; use MediaWiki\Revision\RevisionStore; use MediaWiki\Revision\SlotRecord; use MediaWiki\Storage\NameTableAccessException; +use MediaWiki\StubObject\StubUserLang; use MediaWiki\User\UserOptionsLookup; /** @@ -150,7 +151,7 @@ class DifferenceEngine extends ContextSource { */ private $mNewContent; - /** @var Language */ + /** @var Language|StubUserLang */ protected $mDiffLang; /** @var bool Have the revisions IDs been loaded */ @@ -442,7 +443,7 @@ class DifferenceEngine extends ContextSource { /** * Get the language of the difference engine, defaults to page content language * - * @return Language + * @return Language|StubUserLang */ public function getDiffLang() { # Default language in which the diff text is written. diff --git a/includes/gallery/ImageGalleryBase.php b/includes/gallery/ImageGalleryBase.php index ccb8110b4c3..7b986130f9d 100644 --- a/includes/gallery/ImageGalleryBase.php +++ b/includes/gallery/ImageGalleryBase.php @@ -22,6 +22,7 @@ use MediaWiki\MainConfigNames; use MediaWiki\MediaWikiServices; +use MediaWiki\StubObject\StubUserLang; /** * Image gallery @@ -421,7 +422,7 @@ abstract class ImageGalleryBase extends ContextSource { /** * Determines the correct language to be used for this image gallery - * @return Language + * @return Language|StubUserLang */ protected function getRenderLang() { return $this->mParser diff --git a/includes/language/MessageCache.php b/includes/language/MessageCache.php index e157e893909..f4e16760e14 100644 --- a/includes/language/MessageCache.php +++ b/includes/language/MessageCache.php @@ -33,6 +33,7 @@ use MediaWiki\Page\PageReference; use MediaWiki\Page\PageReferenceValue; use MediaWiki\Revision\SlotRecord; use MediaWiki\StubObject\StubObject; +use MediaWiki\StubObject\StubUserLang; use Psr\Log\LoggerAwareInterface; use Psr\Log\LoggerInterface; use Wikimedia\Rdbms\Database; @@ -1329,7 +1330,7 @@ class MessageCache implements LoggerAwareInterface { * @param PageReference|null $page * @param bool $linestart Whether or not this is at the start of a line * @param bool $interface Whether this is an interface message - * @param Language|string|null $language Language code + * @param Language|StubUserLang|string|null $language Language code * @return ParserOutput|string */ public function parse( $text, PageReference $page = null, $linestart = true, diff --git a/includes/parser/Parser.php b/includes/parser/Parser.php index b97c7f70fba..0cd57bd995b 100644 --- a/includes/parser/Parser.php +++ b/includes/parser/Parser.php @@ -1162,7 +1162,7 @@ class Parser { /** * Get a language object for use in parser functions such as {{FORMATNUM:}} - * @return Language + * @return Language|StubUserLang * @since 1.7 * @deprecated since 1.40; use ::getTargetLanguage() instead. */ diff --git a/includes/title/Title.php b/includes/title/Title.php index c1c1435bf5d..b29c1896a82 100644 --- a/includes/title/Title.php +++ b/includes/title/Title.php @@ -181,7 +181,7 @@ class Title implements LinkTarget, PageIdentity, IDBAccessObject { /** * Shorthand for getting a Language Converter for specific language - * @param Language $language Language of converter + * @param Language|StubUserLang $language Language of converter * @return ILanguageConverter */ private function getLanguageConverter( $language ): ILanguageConverter {