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.

	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	getTestSysop ()
	Convenience method for getting an immutable admin test user.

static	getTestUser ( $groups=[])
	Convenience method for getting an immutable test user.

static	listTables (IMaintainableDatabase $db)

static	prepareServices (Config $bootstrapConfig)
	Prepare service configuration for unit testing.

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.

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.

	assertArrayEquals (array $expected, array $actual, $ordered=false, $named=false)
	Assert that two arrays are equal.

	assertFileContains ( $fileName, $actualData, $createIfMissing=true, $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.

	getDefaultWikitextNS ()
	Returns the ID of a namespace that defaults to Wikitext.

	getNewTempDirectory ()
	obtains a new temporary directory

	getNewTempFile ()
	Obtains a new temporary file name.

	getSchemaOverrides (IMaintainableDatabase $db)
	Stub.

	insertPage ( $pageName, $text='Sample page for unit test.', $namespace=null)
	Insert a new page.

	isWikitextNS ( $ns)
	Returns true if the given namespace defaults to Wikitext according to $wgNamespaceContentModels.

	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.

	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.

	setUp ()

	stashMwGlobals ( $globalKeys)
	Stashes the global, will be restored in tearDown()

	tearDown ()

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	resetGlobalServices (Config $bootstrapConfig=null)
	Reset global services, and install testing environment.

static	setupDatabaseWithTestPrefix (IMaintainableDatabase $db, $prefix)
	Setups a database with the given prefix.

static	setupExternalStoreTestDBs ( $testPrefix)
	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 30 of file ApiFormatBaseTest.php.

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

◆ getMockFormatter()

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

Definition at line 13 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 166 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 91 of file ApiFormatBaseTest.php.

◆ provideHtmlHeader()

static ApiFormatBaseTest::provideHtmlHeader ( )

static

Definition at line 378 of file ApiFormatBaseTest.php.

◆ testApiFrameOptions()

ApiFormatBaseTest::testApiFrameOptions ( )

Definition at line 270 of file ApiFormatBaseTest.php.

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

◆ testBasics()

ApiFormatBaseTest::testBasics ( )

Definition at line 190 of file ApiFormatBaseTest.php.

References getMockFormatter().

◆ testDisable()

ApiFormatBaseTest::testDisable ( )

Definition at line 199 of file ApiFormatBaseTest.php.

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

◆ testFilenameEncoding()

ApiFormatBaseTest::testFilenameEncoding	(	$filename,
		$expect
	)

provideFilenameEncoding

Definition at line 150 of file ApiFormatBaseTest.php.

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

◆ testForceDefaultParams()

ApiFormatBaseTest::testForceDefaultParams ( )

Definition at line 295 of file ApiFormatBaseTest.php.

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

◆ testGetAllowedParams()

ApiFormatBaseTest::testGetAllowedParams ( )

Definition at line 322 of file ApiFormatBaseTest.php.

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

◆ testGetExamplesMessages()

ApiFormatBaseTest::testGetExamplesMessages ( )

Definition at line 335 of file ApiFormatBaseTest.php.

References getMockFormatter().

◆ testHtmlHeader()

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

provideHtmlHeader

Definition at line 352 of file ApiFormatBaseTest.php.

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

◆ testNullMimeType()

ApiFormatBaseTest::testNullMimeType ( )

Definition at line 225 of file ApiFormatBaseTest.php.

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

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

◆ testApiFrameOptions()

◆ testBasics()

◆ testDisable()

◆ testFilenameEncoding()

◆ testForceDefaultParams()

◆ testGetAllowedParams()

◆ testGetExamplesMessages()

◆ testHtmlHeader()

◆ testNullMimeType()

Member Data Documentation

◆ $printerName