Inheritance diagram for ApiFormatBaseTest:

[legend]

Collaboration diagram for ApiFormatBaseTest:

[legend]

Public Member Functions
	getMockFormatter (ApiMain $main=null, $format, $methods=[])

	testApiFrameOptions ()

	testBasics ()

	testDisable ()

	testFilenameEncoding ( $filename, $expect)
	provideFilenameEncoding

	testForceDefaultParams ()

	testGetAllowedParams ()

	testGetExamplesMessages ()

	testHtmlHeader ( $post, $registerNonHtml, $expect)
	provideHtmlHeader

	testNullMimeType ()

Public Member Functions inherited from ApiFormatTestBase
	testGeneralEncoding (array $data, $expect, array $params=[], array $options=[])
	provideGeneralEncoding

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	provideFilenameEncoding ()

static	provideGeneralEncoding ()
	Return general data to be encoded for testing.

static	provideHtmlHeader ()

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
	encodeData (array $params, array $data, $options=[])
	Get the formatter output for the given input data.

	setUp ()

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.

Protected Attributes
	$printerName = 'mockbase'

Protected Attributes inherited from ApiFormatTestBase
string	$printerName
	Name of the formatter being tested.

Protected Attributes inherited from MediaWikiTestCase
Database	$db
	Primary database.

array	$supportedDBs

array	$tablesUsed = []

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.

Detailed Description

API ApiFormatBase.

Definition at line 9 of file ApiFormatBaseTest.php.

Member Function Documentation

◆ encodeData()

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

protected

Get the formatter output for the given input data.

Parameters

array	$params	Query parameters
array	$data	Data to encode
array	$options	Options. 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	$factory	Factory to use instead of the normal one

Returns

string|array The string if $options['returnPrinter'] isn't set, or an array if it is:

text: Output text string
printer: ApiFormatBase

Exceptions

Exception

Reimplemented from ApiFormatTestBase.

Definition at line 37 of file ApiFormatBaseTest.php.

References $options, $params, $response, $ret, getMockFormatter(), and MediaWikiTestCase\setMwGlobals().

◆ getMockFormatter()

ApiFormatBaseTest::getMockFormatter	(	ApiMain	$main = null,
			$format,
			$methods = [] )

Definition at line 20 of file ApiFormatBaseTest.php.

References $context.

Referenced by encodeData(), testApiFrameOptions(), testBasics(), testDisable(), testFilenameEncoding(), testForceDefaultParams(), testGetAllowedParams(), testGetExamplesMessages(), testHtmlHeader(), and testNullMimeType().

◆ provideFilenameEncoding()

static ApiFormatBaseTest::provideFilenameEncoding ( )

static

Definition at line 173 of file ApiFormatBaseTest.php.

◆ provideGeneralEncoding()

static ApiFormatBaseTest::provideGeneralEncoding ( )

static

Return general data to be encoded for testing.

Returns: array See self::testGeneralEncoding

Exceptions

BadMethodCallException

Reimplemented from ApiFormatTestBase.

Definition at line 98 of file ApiFormatBaseTest.php.

◆ provideHtmlHeader()

static ApiFormatBaseTest::provideHtmlHeader ( )

static

Definition at line 385 of file ApiFormatBaseTest.php.

◆ setUp()

ApiFormatBaseTest::setUp ( )

protected

Reimplemented from MediaWikiTestCase.

Definition at line 13 of file ApiFormatBaseTest.php.

References MediaWikiTestCase\setMwGlobals().

◆ testApiFrameOptions()

ApiFormatBaseTest::testApiFrameOptions ( )

Definition at line 277 of file ApiFormatBaseTest.php.

References getMockFormatter(), and MediaWikiTestCase\setMwGlobals().

◆ testBasics()

ApiFormatBaseTest::testBasics ( )

Definition at line 197 of file ApiFormatBaseTest.php.

References getMockFormatter().

◆ testDisable()

ApiFormatBaseTest::testDisable ( )

Definition at line 206 of file ApiFormatBaseTest.php.

References $response, getMockFormatter(), and MediaWikiTestCase\setMwGlobals().

◆ testFilenameEncoding()

ApiFormatBaseTest::testFilenameEncoding	(		$filename,
			$expect )

provideFilenameEncoding

Definition at line 157 of file ApiFormatBaseTest.php.

References $response, $ret, and getMockFormatter().

◆ testForceDefaultParams()

ApiFormatBaseTest::testForceDefaultParams ( )

Definition at line 302 of file ApiFormatBaseTest.php.

References $context, getMockFormatter(), and ApiBase\PARAM_DFLT.

◆ testGetAllowedParams()

ApiFormatBaseTest::testGetAllowedParams ( )

Definition at line 329 of file ApiFormatBaseTest.php.

References getMockFormatter(), ApiBase\PARAM_DFLT, and ApiBase\PARAM_HELP_MSG.

◆ testGetExamplesMessages()

ApiFormatBaseTest::testGetExamplesMessages ( )

Definition at line 342 of file ApiFormatBaseTest.php.

References getMockFormatter().

◆ testHtmlHeader()

ApiFormatBaseTest::testHtmlHeader	(	$post,
		$registerNonHtml,
		$expect )

provideHtmlHeader

Definition at line 359 of file ApiFormatBaseTest.php.

References $context, $request, and getMockFormatter().

◆ testNullMimeType()

ApiFormatBaseTest::testNullMimeType ( )

Definition at line 232 of file ApiFormatBaseTest.php.

References $response, getMockFormatter(), and MediaWikiTestCase\setMwGlobals().

Member Data Documentation

◆ $printerName

ApiFormatBaseTest::$printerName = 'mockbase'

protected

Definition at line 11 of file ApiFormatBaseTest.php.

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

tests/phpunit/includes/api/format/ApiFormatBaseTest.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ encodeData()

◆ getMockFormatter()

◆ provideFilenameEncoding()

◆ provideGeneralEncoding()

◆ provideHtmlHeader()

◆ setUp()

◆ testApiFrameOptions()

◆ testBasics()

◆ testDisable()

◆ testFilenameEncoding()

◆ testForceDefaultParams()

◆ testGetAllowedParams()

◆ testGetExamplesMessages()

◆ testHtmlHeader()

◆ testNullMimeType()

Member Data Documentation

◆ $printerName