MediaWiki  1.30.0
LanguageClassesTestCase Class Reference

Helping class to run tests using a clean language instance. More...

Inherits MediaWikiTestCase.

Inherited by LanguageAmTest, LanguageArqTest, LanguageArTest, LanguageBe_taraskTest, LanguageBeTest, LanguageBhoTest, LanguageBsTest, LanguageCsTest, LanguageCuTest, LanguageCyTest, LanguageDsbTest, LanguageFrTest, LanguageGanTest, LanguageGaTest, LanguageGdTest, LanguageGvTest, LanguageHeTest, LanguageHiTest, LanguageHrTest, LanguageHsbTest, LanguageHuTest, LanguageHyTest, LanguageIuTest, LanguageKkTest, LanguageKshTest, LanguageKuTest, LanguageLnTest, LanguageLtTest, LanguageLvTest, LanguageMgTest, LanguageMkTest, LanguageMlTest, LanguageMoTest, LanguageMtTest, LanguageNlTest, LanguageNsoTest, LanguagePlTest, LanguageRoTest, LanguageRuTest, LanguageSeTest, LanguageSgsTest, LanguageShiTest, LanguageShTest, LanguageSkTest, LanguageSlTest, LanguageSmaTest, LanguageSrTest, LanguageTest, LanguageTgTest, LanguageTiTest, LanguageTlTest, LanguageTrTest, LanguageUkTest, LanguageUzTest, LanguageWaTest, and LanguageZhTest.

Collaboration diagram for LanguageClassesTestCase:

Protected Member Functions

 getLang ()
 
 setUp ()
 Create a new language object before each test. More...
 
 tearDown ()
 Delete the internal language object so each test start out with a fresh language instance. More...
 
- Protected Member Functions inherited from MediaWikiTestCase
 addTmpFiles ( $files)
 
 arrayWrap (array $elements)
 Utility method taking an array of elements and wrapping each element in its own array. More...
 
 assertArrayEquals (array $expected, array $actual, $ordered=false, $named=false)
 Assert that two arrays are equal. More...
 
 assertFileContains ( $fileName, $actualData, $createIfMissing=true, $msg='')
 Check whether file contains given data. More...
 
 assertHTMLEquals ( $expected, $actual, $msg='')
 Put each HTML element on its own line and then equals() the results. More...
 
 assertSelect ( $table, $fields, $condition, array $expectedRows)
 Asserts that the given database query yields the rows given by $expectedRows. More...
 
 assertType ( $type, $actual, $message='')
 Asserts the type of the provided value. More...
 
 assertTypeOrValue ( $type, $actual, $value=false, $message='')
 Asserts that the provided variable is of the specified internal type or equals the $value argument. More...
 
 assertValidHtmlDocument ( $html)
 Asserts that the given string is valid HTML document. More...
 
 assertValidHtmlSnippet ( $html)
 Asserts that the given string is a valid HTML snippet. More...
 
 checkDbIsSupported ()
 
 checkPHPExtension ( $extName)
 Check if $extName is a loaded PHP extension, will skip the test whenever it is not loaded. More...
 
 getDefaultWikitextNS ()
 Returns the ID of a namespace that defaults to Wikitext. More...
 
 getNewTempDirectory ()
 obtains a new temporary directory More...
 
 getNewTempFile ()
 Obtains a new temporary file name. More...
 
 insertPage ( $pageName, $text='Sample page for unit test.', $namespace=null)
 Insert a new page. More...
 
 isWikitextNS ( $ns)
 Returns true if the given namespace defaults to Wikitext according to $wgNamespaceContentModels. More...
 
 markTestSkippedIfNoDiff3 ()
 Check, if $wgDiff3 is set and ready to merge Will mark the calling test as skipped, if not ready. More...
 
 mergeMwGlobalArrayValue ( $name, $values)
 Merges the given values into a MW global array variable. More...
 
 objectAssociativeSort (array &$array)
 Does an associative sort that works for objects. More...
 
 overrideMwServices (Config $configOverrides=null, array $services=[])
 Stashes the global instance of MediaWikiServices, and installs a new one, allowing test cases to override settings and services. More...
 
 setLogger ( $channel, LoggerInterface $logger)
 Sets the logger for a specified channel, for the duration of the test. More...
 
 setMwGlobals ( $pairs, $value=null)
 Sets a global, maintaining a stashed version of the previous global to be restored in tearDown. More...
 
 setService ( $name, $object)
 Sets a service, maintaining a stashed version of the previous service to be restored in tearDown. More...
 
 setTemporaryHook ( $hookName, $handler)
 Create a temporary hook handler which will be reset by tearDown. More...
 
 stashMwGlobals ( $globalKeys)
 Stashes the global, will be restored in tearDown() More...
 

Private Attributes

 $languageObject
 Internal language object. More...
 

Additional Inherited Members

- Public Member Functions inherited from MediaWikiTestCase
 __call ( $func, $args)
 
 __construct ( $name=null, array $data=[], $dataName='')
 
 __destruct ()
 
 addDBData ()
 Stub. More...
 
 addDBDataOnce ()
 Stub. More...
 
 dbPrefix ()
 
 getCliArg ( $offset)
 
 hideDeprecated ( $function)
 Don't throw a warning if $function is deprecated and called later. More...
 
 needsDB ()
 
 run (PHPUnit_Framework_TestResult $result=null)
 
 setCliArg ( $offset, $value)
 
 setContentLang ( $lang)
 
 setupAllTestDBs ()
 Set up all test DBs. More...
 
 setUserLang ( $lang)
 
 testMediaWikiTestCaseParentSetupCalled ()
 Make sure MediaWikiTestCase extending classes have called their parent setUp method. More...
 
 usesTemporaryTables ()
 
- Static Public Member Functions inherited from MediaWikiTestCase
static getMutableTestUser ( $groups=[])
 Convenience method for getting a mutable test user. More...
 
static getTestSysop ()
 Convenience method for getting an immutable admin test user. More...
 
static getTestUser ( $groups=[])
 Convenience method for getting an immutable test user. More...
 
static listTables (IMaintainableDatabase $db)
 
static prepareServices (Config $bootstrapConfig)
 Prepare service configuration for unit testing. More...
 
static setUpBeforeClass ()
 
static setupTestDB (Database $db, $prefix)
 Creates an empty skeleton of the wiki database by cloning its structure to equivalent tables using the given $prefix. More...
 
static teardownTestDB ()
 Restores MediaWiki to using the table set (table prefix) it was using before setupTestDB() was called. More...
 
static wfResetOutputBuffersBarrier ( $buffer)
 Used as a marker to prevent wfResetOutputBuffers from breaking PHPUnit. More...
 
- Public Attributes inherited from MediaWikiTestCase
const DB_PREFIX = 'unittest_'
 Table name prefixes. More...
 
const ORA_DB_PREFIX = 'ut_'
 
- Static Public Attributes inherited from MediaWikiTestCase
static TestUser[] $users
 
- Static Protected Member Functions inherited from MediaWikiTestCase
static getExternalStoreDatabaseConnections ()
 Gets master database connections for all of the ExternalStoreDB stores configured in $wgDefaultExternalStore. More...
 
static isUsingExternalStoreDB ()
 Check whether ExternalStoreDB is being used. More...
 
static resetGlobalServices (Config $bootstrapConfig=null)
 Reset global services, and install testing environment. More...
 
static setupDatabaseWithTestPrefix (IMaintainableDatabase $db, $prefix)
 Setups a database with the given prefix. More...
 
static setupExternalStoreTestDBs ( $testPrefix)
 Clones the External Store database(s) for testing. More...
 
static stripStringKeys (&$r)
 Utility function for eliminating all string keys from an array. More...
 
- Protected Attributes inherited from MediaWikiTestCase
Database $db
 Primary database. More...
 
array $supportedDBs
 
array $tablesUsed = []
 

Detailed Description

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:

Using the crafted language object:
function testHasLanguageObject() {
$langObject = $this->getLang();
$this->assertInstanceOf( 'LanguageFoo',
$langObject
);
}

Definition at line 21 of file LanguageClassesTestCase.php.

Member Function Documentation

◆ getLang()

LanguageClassesTestCase::getLang ( )
protected
Returns
Language

Definition at line 41 of file LanguageClassesTestCase.php.

References $languageObject.

Referenced by LanguageUzTest\convertTo(), LanguageSrTest\convertTo(), LanguageShiTest\testAutoConvertToAllVariants(), LanguageIuTest\testAutoConvertToAllVariants(), LanguageKkTest\testAutoConvertToAllVariants(), LanguageTgTest\testAutoConvertToAllVariants(), LanguageGanTest\testAutoConvertToAllVariants(), LanguageKuTest\testAutoConvertToAllVariants(), LanguageZhTest\testAutoConvertToAllVariants(), LanguageBe_taraskTest\testBeTaraskTestsUsesBeTaraskCode(), LanguageTest\testCheckTitleEncoding(), LanguageBe_taraskTest\testCommafy(), LanguageTest\testCommafy(), LanguageTest\testConvertPlural(), LanguageBe_taraskTest\testDoesNotCommafyFourDigitsNumber(), LanguageTrTest\testDottedAndDotlessI(), LanguageTest\testEmbedBidi(), LanguageRuTest\testExplicitPlural(), LanguageUkTest\testExplicitPlural(), LanguageGdTest\testExplicitPlural(), LanguageTest\testFormatBitrate(), LanguageTest\testFormatDuration(), LanguageArTest\testFormatNum(), LanguageArqTest\testFormatNum(), LanguageNlTest\testFormatNum(), LanguageMlTest\testFormatNum(), LanguageTest\testFormatSize(), LanguageTest\testFormatTimePeriod(), LanguageHeTest\testFourPluralForms(), LanguageLvTest\testGetPluralRuleType(), LanguageGaTest\testGetPluralRuleType(), LanguageMoTest\testGetPluralRuleType(), LanguageBhoTest\testGetPluralRuleType(), LanguageMtTest\testGetPluralRuleType(), LanguageNsoTest\testGetPluralRuleType(), LanguagePlTest\testGetPluralRuleType(), LanguageBsTest\testGetPluralRuleType(), LanguageRoTest\testGetPluralRuleType(), LanguageCsTest\testGetPluralRuleType(), LanguageHiTest\testGetPluralRuleType(), LanguageSeTest\testGetPluralRuleType(), LanguageSgsTest\testGetPluralRuleType(), LanguageHrTest\testGetPluralRuleType(), LanguageHsbTest\testGetPluralRuleType(), LanguageShTest\testGetPluralRuleType(), LanguageHuTest\testGetPluralRuleType(), LanguageSmaTest\testGetPluralRuleType(), LanguageMgTest\testGetPluralRuleType(), LanguageCyTest\testGetPluralRuleType(), LanguageHyTest\testGetPluralRuleType(), LanguageCuTest\testGetPluralRuleType(), LanguageTiTest\testGetPluralRuleType(), LanguageKshTest\testGetPluralRuleType(), LanguageTlTest\testGetPluralRuleType(), LanguageAmTest\testGetPluralRuleType(), LanguageMkTest\testGetPluralRuleType(), LanguageLnTest\testGetPluralRuleType(), LanguageDsbTest\testGetPluralRuleType(), LanguageWaTest\testGetPluralRuleType(), LanguageLtTest\testGetPluralRuleType(), LanguageBeTest\testGetPluralRuleType(), LanguageFrTest\testGetPluralRuleType(), LanguageGvTest\testGetPluralRuleType(), LanguageSkTest\testGetPluralRuleType(), LanguageSlTest\testGetPluralRuleType(), LanguageRuTest\testGetPluralRuleType(), LanguageUkTest\testGetPluralRuleType(), LanguageHeTest\testGetPluralRuleType(), LanguageBe_taraskTest\testGetPluralRuleType(), LanguageArTest\testGetPluralRuleType(), LanguageSrTest\testGetPluralRuleType(), LanguageUkTest\testGrammar(), LanguageRuTest\testGrammar(), LanguageHeTest\testGrammar(), LanguageTest\testLanguageConvertDoubleWidthToSingleWidth(), LanguageTest\testListToText(), LanguageLtTest\testOneFewPlural(), LanguageGaTest\testPlural(), LanguageMgTest\testPlural(), LanguageFrTest\testPlural(), LanguageAmTest\testPlural(), LanguageSmaTest\testPlural(), LanguageMoTest\testPlural(), LanguageWaTest\testPlural(), LanguageTiTest\testPlural(), LanguageKshTest\testPlural(), LanguageGdTest\testPlural(), LanguageLtTest\testPlural(), LanguageTlTest\testPlural(), LanguageBhoTest\testPlural(), LanguageBsTest\testPlural(), LanguagePlTest\testPlural(), LanguageBeTest\testPlural(), LanguageRoTest\testPlural(), LanguageHyTest\testPlural(), LanguageDsbTest\testPlural(), LanguageSeTest\testPlural(), LanguageHrTest\testPlural(), LanguageCuTest\testPlural(), LanguageHsbTest\testPlural(), LanguageMtTest\testPlural(), LanguageHuTest\testPlural(), LanguageCyTest\testPlural(), LanguageLnTest\testPlural(), LanguageNsoTest\testPlural(), LanguageShTest\testPlural(), LanguageMkTest\testPlural(), LanguageCsTest\testPlural(), LanguageHiTest\testPlural(), LanguageLvTest\testPlural(), LanguageUkTest\testPlural(), LanguageSlTest\testPlural(), LanguageSkTest\testPlural(), LanguageGvTest\testPlural(), LanguageRuTest\testPlural(), LanguageBe_taraskTest\testPlural(), LanguageArTest\testPlural(), LanguageSrTest\testPlural(), LanguageSgsTest\testPluralAllForms(), LanguageSmaTest\testPluralTwoForms(), LanguageSeTest\testPluralTwoForms(), LanguageSgsTest\testPluralTwoForms(), LanguageMtTest\testPluralTwoForms(), LanguagePlTest\testPluralTwoForms(), LanguageRuTest\testPluralTwoForms(), LanguageUkTest\testPluralTwoForms(), LanguageBe_taraskTest\testPluralTwoForms(), LanguageSrTest\testPluralTwoForms(), LanguageBe_taraskTest\testSearchRightSingleQuotationMarkAsApostroph(), LanguageArTest\testSprintfDate(), LanguageTest\testSprintfDate(), LanguageTest\testSprintfDateNotAllDigitTimestamp(), LanguageTest\testSprintfDateNoTtlIfNotNeeded(), LanguageTest\testSprintfDateNoZone(), LanguageTest\testSprintfDateTooLongTimestamp(), LanguageTest\testSprintfDateTooShortTimestamp(), LanguageTest\testSprintfDateTZ(), LanguageHeTest\testThreePluralForms(), LanguageTest\testTranslateBlockExpiry(), LanguageTest\testTruncate(), LanguageTest\testTruncateHtml(), and LanguageHeTest\testTwoPluralForms().

◆ setUp()

LanguageClassesTestCase::setUp ( )
protected

Create a new language object before each test.

Reimplemented from MediaWikiTestCase.

Definition at line 48 of file LanguageClassesTestCase.php.

References class, Language\factory(), and wfDebug().

◆ tearDown()

LanguageClassesTestCase::tearDown ( )
protected

Delete the internal language object so each test start out with a fresh language instance.

Reimplemented from MediaWikiTestCase.

Definition at line 70 of file LanguageClassesTestCase.php.

Member Data Documentation

◆ $languageObject

LanguageClassesTestCase::$languageObject
private

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

function testWeAreTheChampions() {
$this->getLang(); # language object
}

Definition at line 36 of file LanguageClassesTestCase.php.

Referenced by getLang().


The documentation for this class was generated from the following file:
LanguageClassesTestCase\getLang
getLang()
Definition: LanguageClassesTestCase.php:41
language
and that you know you can do these things To protect your we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights These restrictions translate to certain responsibilities for you if you distribute copies of the or if you modify it For if you distribute copies of such a whether gratis or for a you must give the recipients all the rights that you have You must make sure that receive or can get the source code And you must show them these terms so they know their rights We protect your rights with two distribute and or modify the software for each author s protection and we want to make certain that everyone understands that there is no warranty for this free software If the software is modified by someone else and passed we want its recipients to know that what they have is not the so that any problems introduced by others will not reflect on the original authors reputations any free program is threatened constantly by software patents We wish to avoid the danger that redistributors of a free program will individually obtain patent in effect making the program proprietary To prevent we have made it clear that any patent must be licensed for everyone s free use or not licensed at all The precise terms and conditions for distribution and modification follow GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR DISTRIBUTION AND MODIFICATION This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License The refers to any such program or and a work based on the Program means either the Program or any derivative work under copyright a work containing the Program or a portion of either verbatim or with modifications and or translated into another language(Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying