API Database medium. More...

Inheritance diagram for ApiOptionsTest:

[legend]

Collaboration diagram for ApiOptionsTest:

[legend]

Public Member Functions
	getOptionKinds (IContextSource $context, $options=null)

	hookGetPreferences ( $user, &$preferences)

	provideOptionManupulation ()

	testAnon ()

	testNoChanges ()

	testNoOptionname ()

	testNoToken ()
	ApiUsageException.

	testOptionManupulation (array $params, array $setOptions, array $result=null, $message='')
	provideOptionManupulation

	testReset ()

	testResetChangeOption ()

	testResetKinds ()

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

Protected Member Functions
	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.

Private Member Functions
	executeQuery ( $request)

	getSampleRequest ( $custom=[])

Private Attributes
DerivativeContext	$mContext

	$mSession

ApiOptions	$mTested

PHPUnit_Framework_MockObject_MockObject	$mUserMock

Static Private Attributes
static	$Success = [ 'options' => 'success' ]

Additional Inherited Members
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.

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

API Database medium.

ApiOptions

Definition at line 10 of file ApiOptionsTest.php.

Member Function Documentation

◆ executeQuery()

ApiOptionsTest::executeQuery ( $request )

private

Definition at line 155 of file ApiOptionsTest.php.

References $request.

Referenced by testAnon(), testNoChanges(), testNoOptionname(), testNoToken(), testOptionManupulation(), testReset(), testResetChangeOption(), and testResetKinds().

◆ getOptionKinds()

ApiOptionsTest::getOptionKinds	(	IContextSource	$context,
			$options = `null`
	)

Parameters

IContextSource	$context
array \| null	$options

Returns: array

Definition at line 111 of file ApiOptionsTest.php.

References $options, $value, and as.

◆ getSampleRequest()

ApiOptionsTest::getSampleRequest ( $custom = [] )

private

Definition at line 144 of file ApiOptionsTest.php.

References $request.

Referenced by testAnon(), testNoChanges(), testNoOptionname(), testNoToken(), testOptionManupulation(), testReset(), testResetChangeOption(), and testResetKinds().

◆ hookGetPreferences()

ApiOptionsTest::hookGetPreferences	(		$user,
		&	$preferences
	)

Definition at line 71 of file ApiOptionsTest.php.

References as.

◆ provideOptionManupulation()

ApiOptionsTest::provideOptionManupulation ( )

Definition at line 315 of file ApiOptionsTest.php.

References false, and true.

◆ setUp()

ApiOptionsTest::setUp ( )

protected

Reimplemented from MediaWikiLangTestCase.

Definition at line 22 of file ApiOptionsTest.php.

References MediaWikiTestCase\mergeMwGlobalArrayValue(), and MediaWikiTestCase\setContentLang().

◆ testAnon()

ApiOptionsTest::testAnon ( )

Definition at line 171 of file ApiOptionsTest.php.

References $e, $request, ApiTestCase\apiExceptionHasCode(), executeQuery(), and getSampleRequest().

◆ testNoChanges()

ApiOptionsTest::testNoChanges ( )

Definition at line 199 of file ApiOptionsTest.php.

References $e, $request, ApiTestCase\apiExceptionHasCode(), executeQuery(), and getSampleRequest().

◆ testNoOptionname()

ApiOptionsTest::testNoOptionname ( )

Definition at line 187 of file ApiOptionsTest.php.

References $e, $request, ApiTestCase\apiExceptionHasCode(), executeQuery(), and getSampleRequest().

◆ testNoToken()

ApiOptionsTest::testNoToken ( )

ApiUsageException.

Definition at line 165 of file ApiOptionsTest.php.

References $request, executeQuery(), and getSampleRequest().

◆ testOptionManupulation()

ApiOptionsTest::testOptionManupulation	(	array	$params,
		array	$setOptions,
		array	$result = `null`,
			$message = `''`
	)

provideOptionManupulation

Parameters

array	$params
array	$setOptions
array \| null	$result

Definition at line 288 of file ApiOptionsTest.php.

References $request, $response, $Success, executeQuery(), and getSampleRequest().

◆ testReset()

ApiOptionsTest::testReset ( )

Definition at line 220 of file ApiOptionsTest.php.

References $request, $response, executeQuery(), and getSampleRequest().

◆ testResetChangeOption()

ApiOptionsTest::testResetChangeOption ( )

Definition at line 256 of file ApiOptionsTest.php.

References $args, $response, executeQuery(), and getSampleRequest().

◆ testResetKinds()

ApiOptionsTest::testResetKinds ( )

Definition at line 238 of file ApiOptionsTest.php.

References $request, $response, executeQuery(), and getSampleRequest().

Member Data Documentation

◆ $mContext

DerivativeContext ApiOptionsTest::$mContext

private

Definition at line 18 of file ApiOptionsTest.php.

◆ $mSession

ApiOptionsTest::$mSession

private

Definition at line 16 of file ApiOptionsTest.php.

◆ $mTested

ApiOptions ApiOptionsTest::$mTested

private

Definition at line 15 of file ApiOptionsTest.php.

◆ $mUserMock

PHPUnit_Framework_MockObject_MockObject ApiOptionsTest::$mUserMock

private

Definition at line 13 of file ApiOptionsTest.php.

◆ $Success

ApiOptionsTest::$Success = [ 'options' => 'success' ]

staticprivate

Definition at line 20 of file ApiOptionsTest.php.

Referenced by testOptionManupulation().

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

tests/phpunit/includes/api/ApiOptionsTest.php

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ executeQuery()

◆ getOptionKinds()

◆ getSampleRequest()

◆ hookGetPreferences()

◆ provideOptionManupulation()

◆ setUp()

◆ testAnon()

◆ testNoChanges()

◆ testNoOptionname()

◆ testNoToken()

◆ testOptionManupulation()

◆ testReset()

◆ testResetChangeOption()

◆ testResetKinds()

Member Data Documentation

◆ $mContext

◆ $mSession

◆ $mTested

◆ $mUserMock

◆ $Success