wiki.techinc.nl/tests/phpunit/languages/LanguageClassesTestCase.php
Umherirrender 205f141bb8 Improve some class properties documentation in tests
Change-Id: Id9c9e56865cf9a6bb112be37a5674ec753604fb1
2021-02-02 16:48:15 +00:00

80 lines
2.1 KiB
PHP

<?php
use MediaWiki\MediaWikiServices;
/**
* Helping class to run tests using a clean language instance.
*
* This is intended for the MediaWiki language class tests under
* tests/phpunit/languages.
*
* Before each tests, a new language object is build which you
* can retrieve in your test using the $this->getLang() method:
*
* @par Using the crafted language object:
* @code
* function testHasLanguageObject() {
* $langObject = $this->getLang();
* $this->assertInstanceOf( 'LanguageFoo',
* $langObject
* );
* }
* @endcode
*/
abstract class LanguageClassesTestCase extends MediaWikiIntegrationTestCase {
/**
* @var Language Internal language object
*
* A new object is created before each tests thanks to PHPUnit
* setUp() method, it is deleted after each test too. To get
* this object you simply use the getLang method.
*
* You must have setup a language code first. See $LanguageClassCode
* @code
* function testWeAreTheChampions() {
* $this->getLang(); # language object
* }
* @endcode
*/
private $languageObject;
/**
* @return Language
*/
protected function getLang() {
return $this->languageObject;
}
/**
* Create a new language object before each test.
*/
protected function setUp() : void {
parent::setUp();
$lang = false;
if ( preg_match( '/Language(.+)Test/', static::class, $m ) ) {
# Normalize language code since classes uses underscores
$lang = strtolower( str_replace( '_', '-', $m[1] ) );
}
if ( $lang === false ||
!MediaWikiServices::getInstance()->getLanguageNameUtils()->isSupportedLanguage( $lang )
) {
# Fallback to english language
$lang = 'en';
wfDebug(
__METHOD__ . ' could not extract a language name '
. 'out of ' . static::class . " failling back to 'en'"
);
}
$this->languageObject = MediaWikiServices::getInstance()->getLanguageFactory()
->getLanguage( $lang );
}
/**
* Delete the internal language object so each test start
* out with a fresh language instance.
*/
protected function tearDown() : void {
unset( $this->languageObject );
parent::tearDown();
}
}