MediaWiki REL1_32
MagicVariableTest Class Reference

Database Parser::getVariableValue. More...

Inheritance diagram for MagicVariableTest:
Collaboration diagram for MagicVariableTest:

Public Member Functions

 assertUnPadded ( $magic, $value)
 assertion helper expecting a magic output which is unpadded
 
 assertZeroPadded ( $magic, $value)
 assertion helper expecting a magic output which is zero padded
 
 testCurrentdayIsUnPadded ( $day)
 provideDays
 
 testCurrentdaytwoIsZeroPadded ( $day)
 provideDays
 
 testCurrentmonthIsZeroPadded ( $month)
 provideMonths
 
 testCurrentmonthoneIsUnPadded ( $month)
 provideMonths
 
 testLocaldayIsUnPadded ( $day)
 provideDays
 
 testLocaldaytwoIsZeroPadded ( $day)
 provideDays
 
 testLocalmonthIsZeroPadded ( $month)
 provideMonths
 
 testLocalmonthoneIsUnPadded ( $month)
 provideMonths
 
 testRevisiondayIsUnPadded ( $day)
 provideDays
 
 testRevisiondaytwoIsZeroPadded ( $day)
 provideDays
 
 testRevisionmonthIsZeroPadded ( $month)
 provideMonths
 
 testRevisionmonthoneIsUnPadded ( $month)
 provideMonths
 
- Public Member Functions inherited from MediaWikiTestCase
 __construct ( $name=null, array $data=[], $dataName='')
 
 __destruct ()
 
 addDBData ()
 Stub.
 
 addDBDataOnce ()
 Stub.
 
 copyTestData (IDatabase $source, IDatabase $target)
 Copy test data from one database connection to another.
 
 dbPrefix ()
 
 getCliArg ( $offset)
 
 hideDeprecated ( $function)
 Don't throw a warning if $function is deprecated and called later.
 
 needsDB ()
 
 run (PHPUnit_Framework_TestResult $result=null)
 
 setCliArg ( $offset, $value)
 
 setContentLang ( $lang)
 
 setGroupPermissions ( $newPerms, $newKey=null, $newValue=null)
 Alters $wgGroupPermissions for the duration of the test.
 
 setupAllTestDBs ()
 Set up all test DBs.
 
 setUserLang ( $lang)
 
 testMediaWikiTestCaseParentSetupCalled ()
 Make sure MediaWikiTestCase extending classes have called their parent setUp method.
 
 usesTemporaryTables ()
 

Static Public Member Functions

static provideDays ()
 
static provideMonths ()
 
- Static Public Member Functions inherited from MediaWikiTestCase
static getMutableTestUser ( $groups=[])
 Convenience method for getting a mutable test user.
 
static getTestPrefixFor (IDatabase $db)
 
static getTestSysop ()
 Convenience method for getting an immutable admin test user.
 
static getTestUser ( $groups=[])
 Convenience method for getting an immutable test user.
 
static installMockMwServices (Config $configOverrides=null)
 Creates a new "mock" MediaWikiServices instance, and installs it.
 
static listTables (IMaintainableDatabase $db)
 
static prepareServices (Config $bootstrapConfig)
 
static resetNonServiceCaches ()
 Resets some non-service singleton instances and other static caches.
 
static restoreMwServices ()
 Restores the original, non-mock MediaWikiServices instance.
 
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.
 
static teardownTestDB ()
 Restores MediaWiki to using the table set (table prefix) it was using before setupTestDB() was called.
 
static wfResetOutputBuffersBarrier ( $buffer)
 Used as a marker to prevent wfResetOutputBuffers from breaking PHPUnit.
 

Protected Member Functions

 setUp ()
 setup a basic parser object
 
- Protected Member Functions inherited from MediaWikiTestCase
 addCoreDBData ()
 
 addTmpFiles ( $files)
 
 arrayWrap (array $elements)
 Utility method taking an array of elements and wrapping each element in its own array.
 
 assertArrayEquals (array $expected, array $actual, $ordered=false, $named=false)
 Assert that two arrays are equal.
 
 assertFileContains ( $fileName, $actualData, $createIfMissing=false, $msg='')
 Check whether file contains given data.
 
 assertHTMLEquals ( $expected, $actual, $msg='')
 Put each HTML element on its own line and then equals() the results.
 
 assertSelect ( $table, $fields, $condition, array $expectedRows, array $options=[], array $join_conds=[])
 Asserts that the given database query yields the rows given by $expectedRows.
 
 assertType ( $type, $actual, $message='')
 Asserts the type of the provided value.
 
 assertTypeOrValue ( $type, $actual, $value=false, $message='')
 Asserts that the provided variable is of the specified internal type or equals the $value argument.
 
 checkDbIsSupported ()
 
 checkPHPExtension ( $extName)
 Check if $extName is a loaded PHP extension, will skip the test whenever it is not loaded.
 
 editPage ( $pageName, $text, $summary='', $defaultNs=NS_MAIN)
 Edits or creates a page/revision.
 
 ensureMockDatabaseConnection (IDatabase $db)
 
 getDefaultWikitextNS ()
 Returns the ID of a namespace that defaults to Wikitext.
 
 getExistingTestPage ( $title=null)
 Returns a WikiPage representing an existing page.
 
 getNewTempDirectory ()
 obtains a new temporary directory
 
 getNewTempFile ()
 Obtains a new temporary file name.
 
 getNonexistingTestPage ( $title=null)
 Returns a WikiPage representing a non-existing page.
 
 getSchemaOverrides (IMaintainableDatabase $db)
 Stub.
 
 insertPage ( $pageName, $text='Sample page for unit test.', $namespace=null, User $user=null)
 Insert a new page.
 
 isTestInDatabaseGroup ()
 
 isWikitextNS ( $ns)
 Returns true if the given namespace defaults to Wikitext according to $wgNamespaceContentModels.
 
 markTestSkippedIfDbType ( $type)
 Skip the test if using the specified database type.
 
 markTestSkippedIfNoDiff3 ()
 Check, if $wgDiff3 is set and ready to merge Will mark the calling test as skipped, if not ready.
 
 mergeMwGlobalArrayValue ( $name, $values)
 Merges the given values into a MW global array variable.
 
 objectAssociativeSort (array &$array)
 Does an associative sort that works for objects.
 
 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.
 
 revisionDelete ( $rev, array $value=[Revision::DELETED_TEXT=> 1], $comment='')
 Revision-deletes a revision.
 
 setIniSetting ( $name, $value)
 Set an ini setting for the duration of the test.
 
 setLogger ( $channel, LoggerInterface $logger)
 Sets the logger for a specified channel, for the duration of the test.
 
 setMwGlobals ( $pairs, $value=null)
 Sets a global, maintaining a stashed version of the previous global to be restored in tearDown.
 
 setService ( $name, $object)
 Sets a service, maintaining a stashed version of the previous service to be restored in tearDown.
 
 setTemporaryHook ( $hookName, $handler)
 Create a temporary hook handler which will be reset by tearDown.
 
 stashMwGlobals ( $globalKeys)
 Stashes the global, will be restored in tearDown()
 
 tearDown ()
 
 truncateTable ( $tableName, IDatabase $db=null)
 Empties the given table and resets any auto-increment counters.
 

Private Member Functions

 assertMagic ( $expected, $magic)
 Assertion helper to test a magic variable output.
 
 assertMagicPadding ( $magic, $value, $format)
 Main assertion helper for magic variables padding.
 
 setParserTS ( $ts)
 helper to set the parser timestamp and revision timestamp
 

Static Private Member Functions

static createProviderUpTo ( $num)
 

Private Attributes

 $expectedAsInteger
 An array of magicword returned as type integer by the parser They are usually returned as a string for i18n since we support persan numbers for example, but some magic explicitly return them as integer.
 
Parser $testParser = null
 

Additional Inherited Members

- Public Attributes inherited from MediaWikiTestCase
const DB_PREFIX = 'unittest_'
 Table name prefixes.
 
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.
 
static isUsingExternalStoreDB ()
 Check whether ExternalStoreDB is being used.
 
static setupDatabaseWithTestPrefix (IMaintainableDatabase $db, $prefix=null)
 Setups a database with cloned tables using the given prefix.
 
static setupExternalStoreTestDBs ( $testPrefix=null)
 Clones the External Store database(s) for testing.
 
static stripStringKeys (&$r)
 Utility function for eliminating all string keys from an array.
 
- Protected Attributes inherited from MediaWikiTestCase
Database $db
 Primary database.
 
array $supportedDBs
 
array $tablesUsed = []
 

Detailed Description

Database Parser::getVariableValue.

Definition at line 18 of file MagicVariableTest.php.

Member Function Documentation

◆ assertMagic()

MagicVariableTest::assertMagic (   $expected,
  $magic 
)
private

Assertion helper to test a magic variable output.

Parameters
string | int$expected
string$magic

Definition at line 211 of file MagicVariableTest.php.

Referenced by assertMagicPadding().

◆ assertMagicPadding()

MagicVariableTest::assertMagicPadding (   $magic,
  $value,
  $format 
)
private

Main assertion helper for magic variables padding.

Parameters
string$magicMagic variable name
mixed$valueMonth or day
string$formatSprintf format for $value

Definition at line 176 of file MagicVariableTest.php.

References $value, assertMagic(), and setParserTS().

Referenced by assertUnPadded(), and assertZeroPadded().

◆ assertUnPadded()

MagicVariableTest::assertUnPadded (   $magic,
  $value 
)

◆ assertZeroPadded()

MagicVariableTest::assertZeroPadded (   $magic,
  $value 
)

◆ createProviderUpTo()

static MagicVariableTest::createProviderUpTo (   $num)
staticprivate
Parameters
int$numUpper limit for numbers
Returns
array Array of numbers from 1 up to $num

Definition at line 62 of file MagicVariableTest.php.

References $ret.

Referenced by provideDays(), and provideMonths().

◆ provideDays()

static MagicVariableTest::provideDays ( )
static
Returns
array Array of days numbers (as an integer)

Definition at line 81 of file MagicVariableTest.php.

References createProviderUpTo().

◆ provideMonths()

static MagicVariableTest::provideMonths ( )
static
Returns
array Array of months numbers (as an integer)

Definition at line 74 of file MagicVariableTest.php.

References createProviderUpTo().

◆ setParserTS()

MagicVariableTest::setParserTS (   $ts)
private

helper to set the parser timestamp and revision timestamp

Parameters
string$ts

Definition at line 201 of file MagicVariableTest.php.

Referenced by assertMagicPadding().

◆ setUp()

MagicVariableTest::setUp ( )
protected

setup a basic parser object

Reimplemented from MediaWikiTestCase.

Definition at line 37 of file MagicVariableTest.php.

References $title, and MediaWikiTestCase\setContentLang().

◆ testCurrentdayIsUnPadded()

MagicVariableTest::testCurrentdayIsUnPadded (   $day)

provideDays

Definition at line 93 of file MagicVariableTest.php.

References assertUnPadded().

◆ testCurrentdaytwoIsZeroPadded()

MagicVariableTest::testCurrentdaytwoIsZeroPadded (   $day)

provideDays

Definition at line 98 of file MagicVariableTest.php.

References assertZeroPadded().

◆ testCurrentmonthIsZeroPadded()

MagicVariableTest::testCurrentmonthIsZeroPadded (   $month)

provideMonths

Definition at line 115 of file MagicVariableTest.php.

References assertZeroPadded().

◆ testCurrentmonthoneIsUnPadded()

MagicVariableTest::testCurrentmonthoneIsUnPadded (   $month)

provideMonths

Definition at line 120 of file MagicVariableTest.php.

References assertUnPadded().

◆ testLocaldayIsUnPadded()

MagicVariableTest::testLocaldayIsUnPadded (   $day)

provideDays

Definition at line 103 of file MagicVariableTest.php.

References assertUnPadded().

◆ testLocaldaytwoIsZeroPadded()

MagicVariableTest::testLocaldaytwoIsZeroPadded (   $day)

provideDays

Definition at line 108 of file MagicVariableTest.php.

References assertZeroPadded().

◆ testLocalmonthIsZeroPadded()

MagicVariableTest::testLocalmonthIsZeroPadded (   $month)

provideMonths

Definition at line 125 of file MagicVariableTest.php.

References assertZeroPadded().

◆ testLocalmonthoneIsUnPadded()

MagicVariableTest::testLocalmonthoneIsUnPadded (   $month)

provideMonths

Definition at line 130 of file MagicVariableTest.php.

References assertUnPadded().

◆ testRevisiondayIsUnPadded()

MagicVariableTest::testRevisiondayIsUnPadded (   $day)

provideDays

Definition at line 137 of file MagicVariableTest.php.

References assertUnPadded().

◆ testRevisiondaytwoIsZeroPadded()

MagicVariableTest::testRevisiondaytwoIsZeroPadded (   $day)

provideDays

Definition at line 142 of file MagicVariableTest.php.

References assertZeroPadded().

◆ testRevisionmonthIsZeroPadded()

MagicVariableTest::testRevisionmonthIsZeroPadded (   $month)

provideMonths

Definition at line 149 of file MagicVariableTest.php.

References assertZeroPadded().

◆ testRevisionmonthoneIsUnPadded()

MagicVariableTest::testRevisionmonthoneIsUnPadded (   $month)

provideMonths

Definition at line 154 of file MagicVariableTest.php.

References assertUnPadded().

Member Data Documentation

◆ $expectedAsInteger

MagicVariableTest::$expectedAsInteger
private
Initial value:
= [
'revisionday',
'revisionmonth1',
]

An array of magicword returned as type integer by the parser They are usually returned as a string for i18n since we support persan numbers for example, but some magic explicitly return them as integer.

See also
MagicVariableTest::assertMagic()

Definition at line 31 of file MagicVariableTest.php.

◆ $testParser

Parser MagicVariableTest::$testParser = null
private

Definition at line 22 of file MagicVariableTest.php.


The documentation for this class was generated from the following file: