MediaWiki  1.23.12
ApiQueryContinueTestBase Class Reference
Inheritance diagram for ApiQueryContinueTestBase:
Collaboration diagram for ApiQueryContinueTestBase:

Protected Member Functions

 checkC ( $expected, $params, $expectedCount, $id, $continue=true)
 Run query() and compare against expected values. More...
 
 mergeResult (&$results, $newResult, $numericIds=false)
 Recursively merge the new result returned from the query to the previous results. More...
 
 query ( $params, $expectedCount, $id, $useContinue=true)
 Run query in a loop until no more values are available. More...
 
- Protected Member Functions inherited from ApiQueryTestBase
 assertResult ( $exp, $result, $message='')
 
 check ( $values)
 Checks that the request's result matches the expected results. More...
 
 merge ()
 Merges all requests parameter + expected values into one. More...
 
- Protected Member Functions inherited from ApiTestCase
 doApiRequest (array $params, array $session=null, $appendModule=false, User $user=null)
 Does the API request and returns the result. More...
 
 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. More...
 
 doLogin ( $user='sysop')
 
 editPage ( $pageName, $text, $summary='', $defaultNs=NS_MAIN)
 Edits or creates a page/revision. More...
 
 getTokenList ( $user, $session=null)
 
 setUp ()
 
- Protected Member Functions inherited from MediaWikiTestCase
 arrayWrap (array $elements)
 Utility method taking an array of elements and wrapping each element in it's own array. More...
 
 assertArrayEquals (array $expected, array $actual, $ordered=false, $named=false)
 Assert that two arrays are equal. More...
 
 assertException ( $code, $expected='Exception', $message='')
 Asserts that an exception of the specified type occurs when running the provided code. 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)
 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...
 
 assertValidHtmlDocument ( $html)
 Asserts that the given string is valid HTML document. More...
 
 assertValidHtmlSnippet ( $html)
 Asserts that the given string is a valid HTML snippet. More...
 
 checkDbIsSupported ()
 
 checkHasDiff3 ()
 Check, if $wgDiff3 is set and ready to merge Will mark the calling test as skipped, if not ready. More...
 
 checkHasGzip ()
 Check whether we have the 'gzip' commandline utility, will skip the test whenever "gzip -V" fails. More...
 
 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...
 
 isWikitextNS ( $ns)
 Returns true if the given namespace defaults to Wikitext according to $wgNamespaceContentModels. 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...
 
 setMwGlobals ( $pairs, $value=null)
 
 stashMwGlobals ( $globalKeys)
 Stashes the global, will be restored in tearDown() More...
 
 tearDown ()
 

Protected Attributes

 $mVerbose = false
 Enable to print in-depth debugging info during the test run. More...
 
- Protected Attributes inherited from ApiTestCase
ApiTestContext $apiContext
 
- Protected Attributes inherited from MediaWikiTestCase
DatabaseBase $db
 
array $supportedDBs
 
array $tablesUsed = array()
 

Private Member Functions

 printResult ( $data)
 

Static Private Member Functions

static GetItems ( $q, $moduleName, $name, &$print)
 

Additional Inherited Members

- Public Member Functions inherited from ApiTestCase
 testApiTestGroup ()
 
- Public Member Functions inherited from MediaWikiTestCase
 __call ( $func, $args)
 
 __construct ( $name=null, array $data=array(), $dataName='')
 
 addDBData ()
 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)
 
 testMediaWikiTestCaseParentSetupCalled ()
 Make sure MediaWikiTestCase extending classes have called their parent setUp method. More...
 
 usesTemporaryTables ()
 
- Static Public Member Functions inherited from MediaWikiTestCase
static listTables ( $db)
 
static setupTestDB (DatabaseBase $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...
 
- Public Attributes inherited from ApiQueryTestBase
const PARAM_ASSERT =
 
- 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 $users
 
- Static Protected Member Functions inherited from MediaWikiTestCase
static stripStringKeys (&$r)
 Utility function for eliminating all string keys from an array. More...
 
- Static Protected Attributes inherited from ApiTestCase
static $apiUrl
 

Detailed Description

Definition at line 27 of file ApiQueryContinueTestBase.php.

Member Function Documentation

◆ checkC()

◆ GetItems()

static ApiQueryContinueTestBase::GetItems (   $q,
  $moduleName,
  $name,
$print 
)
staticprivate

Definition at line 152 of file ApiQueryContinueTestBase.php.

Referenced by printResult().

◆ mergeResult()

ApiQueryContinueTestBase::mergeResult ( $results,
  $newResult,
  $numericIds = false 
)
protected

Recursively merge the new result returned from the query to the previous results.

Parameters
mixed$results
mixed$newResult
bool$numericIdsIf true, treat keys as ids to be merged instead of appending

Definition at line 169 of file ApiQueryContinueTestBase.php.

References $sort, $value, and as.

Referenced by query().

◆ printResult()

ApiQueryContinueTestBase::printResult (   $data)
private
Parameters
array$data

Definition at line 116 of file ApiQueryContinueTestBase.php.

References array(), as, and GetItems().

Referenced by query().

◆ query()

ApiQueryContinueTestBase::query (   $params,
  $expectedCount,
  $id,
  $useContinue = true 
)
protected

Run query in a loop until no more values are available.

Parameters
array$paramsapi parameters
int$expectedCountmax number of iterations
string$idunit test id
boolean$useContinuetrue to use smart continue
Returns
mixed: merged results data array
Exceptions
Exception

Definition at line 51 of file ApiQueryContinueTestBase.php.

References $count, $e, $params, array(), ApiTestCase\doApiRequest(), fail, mergeResult(), and printResult().

Referenced by checkC(), ApiQueryContinueTest\test1List(), ApiQueryContinueTest\test2Lists(), ApiQueryContinue2Test\testA(), ApiQueryContinueTest\testGen1Prop(), ApiQueryContinueTest\testGen1Prop1List(), ApiQueryContinueTest\testGen2Prop(), ApiQueryContinueTest\testGen2Prop2List1Meta(), ApiQueryContinueTest\testSameGenAndProp(), and ApiQueryContinueTest\testSameGenList().

Member Data Documentation

◆ $mVerbose

ApiQueryContinueTestBase::$mVerbose = false
protected

Enable to print in-depth debugging info during the test run.

Definition at line 32 of file ApiQueryContinueTestBase.php.


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