MediaWiki  1.23.2
ApiTestCaseUpload Class Reference
Inheritance diagram for ApiTestCaseUpload:
Collaboration diagram for ApiTestCaseUpload:

Public Member Functions

 clearFakeUploads ()
 Remove traces of previous fake uploads. More...
 
 clearTempUpload ()
 
 deleteFileByContent ( $filePath)
 Helper function – given a file on the filesystem, find matching content in the db (and associated articles) and remove them. More...
 
 deleteFileByFileName ( $fileName)
 Helper function – remove files and associated articles with a particular filename. More...
 
 deleteFileByTitle ( $title)
 Helper function – remove files and associated articles by Title. More...
 
 fakeUploadChunk ( $fieldName, $fileName, $type, & $chunkData)
 
 fakeUploadFile ( $fieldName, $fileName, $type, $filePath)
 Fake an upload by dumping the file into temp space, and adding info to $_FILES. More...
 
- 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 ()
 

Protected Member Functions

 setUp ()
 Fixture – run before every test. More...
 
 tearDown ()
 
- 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)
 
- 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...
 

Additional Inherited Members

- 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 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...
 
- Protected Attributes inherited from ApiTestCase
ApiTestContext $apiContext
 
- Protected Attributes inherited from MediaWikiTestCase
DatabaseBase $db
 
array $supportedDBs
 
array $tablesUsed = array()
 
- Static Protected Attributes inherited from ApiTestCase
static $apiUrl
 

Detailed Description

  • Abstract class to support upload tests

Definition at line 7 of file ApiTestCaseUpload.php.

Member Function Documentation

◆ clearFakeUploads()

ApiTestCaseUpload::clearFakeUploads ( )

Remove traces of previous fake uploads.

Definition at line 159 of file ApiTestCaseUpload.php.

References array().

Referenced by setUp(), ApiUploadTest\testUploadChunks(), and ApiUploadTest\testUploadStash().

◆ clearTempUpload()

ApiTestCaseUpload::clearTempUpload ( )

Definition at line 147 of file ApiTestCaseUpload.php.

Referenced by tearDown().

◆ deleteFileByContent()

ApiTestCaseUpload::deleteFileByContent (   $filePath)

Helper function – given a file on the filesystem, find matching content in the db (and associated articles) and remove them.

Parameters
string$filePathpath to file on the filesystem
Returns
bool

Definition at line 75 of file ApiTestCaseUpload.php.

References $hash, $success, as, deleteFileByTitle(), FSFile\getSha1Base36FromPath(), and RepoGroup\singleton().

Referenced by ApiUploadTest\testUpload(), ApiUploadTest\testUploadChunks(), ApiUploadTest\testUploadSameContent(), and ApiUploadTest\testUploadStash().

◆ deleteFileByFileName()

ApiTestCaseUpload::deleteFileByFileName (   $fileName)

Helper function – remove files and associated articles with a particular filename.

Parameters
string$fileNamefilename to be removed
Returns
bool

Definition at line 64 of file ApiTestCaseUpload.php.

References deleteFileByTitle(), Title\newFromText(), and NS_FILE.

Referenced by ApiUploadTest\testUpload(), ApiUploadTest\testUploadChunks(), ApiUploadTest\testUploadSameContent(), ApiUploadTest\testUploadSameFileName(), ApiUploadTest\testUploadStash(), and ApiUploadTest\testUploadZeroLength().

◆ deleteFileByTitle()

ApiTestCaseUpload::deleteFileByTitle (   $title)

Helper function – remove files and associated articles by Title.

Parameters
Title$titletitle to be removed
Returns
bool

Definition at line 37 of file ApiTestCaseUpload.php.

References $comment, $file, $title, array(), FileDeleteForm\doDelete(), WikiPage\factory(), Title\newFromText(), NS_FILE, and wfFindFile().

Referenced by deleteFileByContent(), and deleteFileByFileName().

◆ fakeUploadChunk()

ApiTestCaseUpload::fakeUploadChunk (   $fieldName,
  $fileName,
  $type,
$chunkData 
)

Definition at line 125 of file ApiTestCaseUpload.php.

References $size, $type, array(), and wfTempDir().

Referenced by ApiUploadTest\testUploadChunks().

◆ fakeUploadFile()

ApiTestCaseUpload::fakeUploadFile (   $fieldName,
  $fileName,
  $type,
  $filePath 
)

Fake an upload by dumping the file into temp space, and adding info to $_FILES.

(This is what PHP would normally do).

Parameters
string$fieldNamename this would have in the upload form
string$fileNamename to title this
string$typemime type
string$filePathpath where to find file contents
Exceptions
Exception
Returns
bool

Definition at line 98 of file ApiTestCaseUpload.php.

References $size, $type, array(), and wfTempDir().

Referenced by ApiUploadTest\testUpload(), ApiUploadTest\testUploadSameContent(), ApiUploadTest\testUploadSameFileName(), ApiUploadTest\testUploadStash(), and ApiUploadTest\testUploadZeroLength().

◆ setUp()

ApiTestCaseUpload::setUp ( )
protected

Fixture – run before every test.

Reimplemented from ApiTestCase.

Definition at line 11 of file ApiTestCaseUpload.php.

References array(), clearFakeUploads(), MediaWikiTestCase\setMwGlobals(), and wfSetupSession().

◆ tearDown()

ApiTestCaseUpload::tearDown ( )
protected

Reimplemented from MediaWikiTestCase.

Definition at line 24 of file ApiTestCaseUpload.php.

References clearTempUpload().


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