MediaWiki  REL1_24
ApiTestCase Class Reference
Inheritance diagram for ApiTestCase:
Collaboration diagram for ApiTestCase:

List of all members.

Public Member Functions

 testApiTestGroup ()

Protected Member Functions

 doApiRequest (array $params, array $session=null, $appendModule=false, User $user=null)
 Does the API request and returns the result.
 doApiRequestWithToken (array $params, array $session=null, User $user=null)
 Add an edit token to the API request This is cheating a bit -- we grab a token in the correct format and then add it to the pseudo-session and to the request, without actually requesting a "real" edit token.
 doLogin ($user= 'sysop')
 editPage ($pageName, $text, $summary= '', $defaultNs=NS_MAIN)
 Edits or creates a page/revision.
 getTokenList ($user, $session=null)
 setUp ()

Protected Attributes

ApiTestContext $apiContext

Static Protected Attributes

static $apiUrl

Detailed Description

Definition at line 3 of file ApiTestCase.php.


Member Function Documentation

ApiTestCase::doApiRequest ( array params,
array session = null,
appendModule = false,
User user = null 
) [protected]

Does the API request and returns the result.

The returned value is an array containing

  • the result data (array)
  • the request (WebRequest)
  • the session data of the request (array)
  • if $appendModule is true, the Api module $module
Parameters:
array$params
array | null$session
bool$appendModule
User | null$user
Returns:
array

Reimplemented in UploadFromUrlTest.

Definition at line 74 of file ApiTestCase.php.

Referenced by ApiFormatTestBase\apiRequest(), ApiQueryTestBase\check(), doLogin(), getTokenList(), ApiQueryContinueTestBase\query(), ApiLoginTest\testApiLoginBadPass(), ApiLoginTest\testApiLoginGoodPass(), ApiLoginTest\testApiLoginNoName(), ApiMainTest\testAssert(), ApiBlockTest\testBlockingActionWithNoToken(), ApiQueryAllPagesTest\testBug25702(), ApiQueryRevisionsTest\testContentComesWithContentModelAndFormat(), ApiCreateAccountTest\testExistingUser(), ApiWatchTest\testGetRollbackToken(), ApiRevisionDeleteTest\testHidingRevisions(), ApiCreateAccountTest\testInvalidEmail(), ApiUploadTest\testLogin(), ApiBlockTest\testMakeNormalBlock(), ApiCreateAccountTest\testNoName(), ApiCreateAccountTest\testNoPassword(), ApiParseTest\testParseNonexistentPage(), ApiPurgeTest\testPurgeMainPage(), ApiLoginTest\testRunLogin(), ApiQueryTest\testTitlesAreRejectedIfInvalid(), ApiQueryTest\testTitlesGetNormalized(), ApiRevisionDeleteTest\testUnhidingOutput(), ApiUploadTest\testUploadRequiresToken(), ApiCreateAccountTest\testValid(), ApiWatchTest\testWatchClear(), ApiWatchTest\testWatchEdit(), ApiWatchTest\testWatchProtect(), ApiWatchTest\testWatchRollback(), and ApiUnblockTest\testWithNoToken().

ApiTestCase::doApiRequestWithToken ( array params,
array session = null,
User user = null 
) [protected]

Add an edit token to the API request This is cheating a bit -- we grab a token in the correct format and then add it to the pseudo-session and to the request, without actually requesting a "real" edit token.

Parameters:
array$paramsKey-value API params
array | null$sessionSession array
User | null$userA User object for the context
Returns:
array Result of the API call
Exceptions:
ExceptionIn case wsToken is not set in the session

Definition at line 126 of file ApiTestCase.php.

Referenced by ApiEditPageTest\testEdit(), ApiEditPageTest\testEdit_redirect(), ApiEditPageTest\testEdit_redirectText(), ApiEditPageTest\testEditAppend(), ApiEditPageTest\testEditConflict(), ApiEditPageTest\testEditConflict_bug41990(), ApiEditPageTest\testEditConflict_newSection(), ApiEditPageTest\testEditNewSection(), ApiEditPageTest\testEditSection(), ApiEditPageTest\testNonTextEdit(), ApiUploadTest\testUpload(), ApiUploadTest\testUploadChunks(), ApiUploadTest\testUploadMissingParams(), ApiUploadTest\testUploadSameContent(), ApiUploadTest\testUploadSameFileName(), ApiUploadTest\testUploadStash(), and ApiUploadTest\testUploadZeroLength().

ApiTestCase::editPage ( pageName,
text,
summary = '',
defaultNs = NS_MAIN 
) [protected]

Edits or creates a page/revision.

Parameters:
string$pageNamePage title
string$textContent of the page
string$summaryOptional summary string for the revision
int$defaultNsOptional namespace id
Returns:
array Array as returned by WikiPage::doEditContent()

Definition at line 51 of file ApiTestCase.php.

Referenced by ApiQueryContinue2Test\addDBData(), ApiQueryContinueTest\addDBData(), ApiQueryBasicTest\addDBData(), ApiRevisionDeleteTest\setUp(), and ApiQueryBasicTest\testGeneratorRedirects().

ApiTestCase::getTokenList ( user,
session = null 
) [protected]

Definition at line 185 of file ApiTestCase.php.


Member Data Documentation

ApiTestContext ApiTestCase::$apiContext [protected]

Definition at line 8 of file ApiTestCase.php.

ApiTestCase::$apiUrl [static, protected]

Definition at line 4 of file ApiTestCase.php.


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