Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve documentation of the PageContentLanguage hook

Browse source 
Clarify that the type of second parameter that is being passed
to the hooks can be anything because one hook can change it and
then it is passed to another hook without the hook caller having
possibility to check or modify the value.

Clarify that hooks should only return Language objects.

Rename $wgLang to $userLang in the hook parameter documentation to
avoid false posivite matches for the global.

Fix some typos, use Title::inNamespace and add a test assertion.

Also, the $content parameter is unused by all implementations of
this method, and on quick look never passed by any caller. I kept
it for now, however.

Bug: T214358
Change-Id: Iae49d2998c2b762565d232c0337d84d43a4a900c
This commit is contained in:
Niklas Laxström 2019-03-06 13:23:06 +01:00
parent ae87a51b05
commit a08fc9eed6
3 changed files with 8 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/hooks.txt
View file

@ -2441,10 +2441,12 @@ $flags: Flags passed to WikiPage::doEditContent()
$revision: New Revision of the article
'PageContentLanguage': Allows changing the language in which the content of a
page is written. Defaults to the wiki content language ($wgContLang).
page is written. Defaults to the wiki content language.
$title: Title object
&$pageLang: the page content language (either an object or a language code)
$wgLang: the user language
&$pageLang: the page content language. Input can be anything (under control of
hook subscribers), but hooks should return Language objects. Language code
strings are deprecated.
$userLang: the user language (Language or StubUserLang object)
'PageContentSave': Before an article is saved.
$wikiPage: the WikiPage (object) being saved

4
includes/content/ContentHandler.php
View file

@ -667,7 +667,7 @@ abstract class ContentHandler {
* This default implementation just returns the content language (except for pages
* in the MediaWiki namespace)
*
* Note that the pages language is not cacheable, since it may in some
* Note that the page's language is not cacheable, since it may in some
* cases depend on user settings.
*
* Also note that the page language may or may not depend on the actual content of the page,
@ -684,7 +684,7 @@ abstract class ContentHandler {
global $wgLang;
$pageLang = MediaWikiServices::getInstance()->getContentLanguage();
if ( $title->getNamespace() == NS_MEDIAWIKI ) {
if ( $title->inNamespace( NS_MEDIAWIKI ) ) {
// Parse mediawiki messages with correct target language
list( /* $unused */, $lang ) = MessageCache::singleton()->figureMessage( $title->getText() );
$pageLang = Language::factory( $lang );

1
tests/phpunit/includes/content/ContentHandlerTest.php
View file

@ -158,6 +158,7 @@ class ContentHandlerTest extends MediaWikiTestCase {
$handler = ContentHandler::getForTitle( $title );
$lang = $handler->getPageLanguage( $title );
$this->assertInstanceOf( Language::class, $lang );
$this->assertEquals( $expected->getCode(), $lang->getCode() );
}