MediaWiki  REL1_31
ApiFormatTestBase Class Reference
Inheritance diagram for ApiFormatTestBase:
Collaboration diagram for ApiFormatTestBase:

Public Member Functions

 testGeneralEncoding (array $data, $expect, array $params=[], array $options=[])
 provideGeneralEncoding More...
 
- Public Member Functions inherited from MediaWikiTestCase
 __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)
 
 setGroupPermissions ( $newPerms, $newKey=null, $newValue=null)
 Alters $wgGroupPermissions for the duration of the test. More...
 
 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

static provideGeneralEncoding ()
 Return general data to be encoded for testing. More...
 
- 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...
 

Protected Member Functions

 encodeData (array $params, array $data, $options=[])
 Get the formatter output for the given input data. 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, array $options=[], array $join_conds=[])
 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...
 
 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...
 
 getSchemaOverrides (IMaintainableDatabase $db)
 Stub. 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...
 
 setUp ()
 
 stashMwGlobals ( $globalKeys)
 Stashes the global, will be restored in tearDown() More...
 
 tearDown ()
 

Protected Attributes

string $printerName
 Name of the formatter being tested. More...
 
- Protected Attributes inherited from MediaWikiTestCase
Database $db
 Primary database. More...
 
array $supportedDBs
 
array $tablesUsed = []
 

Additional Inherited Members

- 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...
 

Detailed Description

Definition at line 3 of file ApiFormatTestBase.php.

Member Function Documentation

◆ encodeData()

ApiFormatTestBase::encodeData ( array  $params,
array  $data,
  $options = [] 
)
protected

Get the formatter output for the given input data.

Parameters
array$paramsQuery parameters
array$dataData to encode
array$optionsOptions. If passed a string, the string is treated as the 'class' option.
  • name: Format name, rather than $this->printerName
  • class: If set, register 'name' with this class (and 'factory', if that's set)
  • factory: Used with 'class' to register at runtime
  • returnPrinter: Return the printer object
callable | null$factoryFactory to use instead of the normal one
Returns
string|array The string if $options['returnPrinter'] isn't set, or an array if it is:
Exceptions
Exception

Reimplemented in ApiFormatBaseTest.

Definition at line 36 of file ApiFormatTestBase.php.

References $context, $options, $params, $printerName, $ret, and as.

Referenced by testGeneralEncoding().

◆ provideGeneralEncoding()

static ApiFormatTestBase::provideGeneralEncoding ( )
static

Return general data to be encoded for testing.

Returns
array See self::testGeneralEncoding
Exceptions
BadMethodCallException

Reimplemented in ApiFormatXmlTest, ApiFormatRawTest, ApiFormatPhpTest, ApiFormatNoneTest, ApiFormatJsonTest, and ApiFormatBaseTest.

Definition at line 16 of file ApiFormatTestBase.php.

References class.

◆ testGeneralEncoding()

ApiFormatTestBase::testGeneralEncoding ( array  $data,
  $expect,
array  $params = [],
array  $options = [] 
)

provideGeneralEncoding

Parameters
array$dataData to be encoded
string | Exception$expectString to expect, or exception expected to be thrown
array$paramsQuery parameters to set in the FauxRequest
array$optionsOptions to pass to self::encodeData()

Definition at line 82 of file ApiFormatTestBase.php.

References $options, $params, and encodeData().

Referenced by ApiFormatRawTest\testFailWithHTTPError().

Member Data Documentation

◆ $printerName

string ApiFormatTestBase::$printerName
protected

Name of the formatter being tested.

Definition at line 9 of file ApiFormatTestBase.php.

Referenced by encodeData().


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