[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/api/ -> ApiUpload.php (summary)

Created on Aug 21, 2008 Copyright © 2008 - 2010 Bryan Tong Minh <[email protected]>

File Size: 792 lines (26 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

ApiUpload:: (23 methods):
  execute()
  getContextResult()
  getStashResult()
  getWarningsResult()
  getChunkResult()
  performStash()
  dieRecoverableError()
  selectUploadModule()
  checkPermissions()
  verifyUpload()
  checkVerification()
  getApiWarnings()
  transformWarnings()
  performUpload()
  checkAsyncDownloadEnabled()
  mustBePosted()
  isWriteMode()
  getAllowedParams()
  getParamDescription()
  getDescription()
  needsToken()
  getExamples()
  getHelpUrls()


Class: ApiUpload  - X-Ref


execute()   X-Ref
No description

getContextResult()   X-Ref
Get an upload result based on upload context

return: array

getStashResult( $warnings )   X-Ref
Get Stash Result, throws an exception if the file could not be stashed.

param: array $warnings Array of Api upload warnings
return: array

getWarningsResult( $warnings )   X-Ref
Get Warnings Result

param: array $warnings Array of Api upload warnings
return: array

getChunkResult( $warnings )   X-Ref
Get the result of a chunk upload.

param: array $warnings Array of Api upload warnings
return: array

performStash()   X-Ref
Stash the file and return the file key
Also re-raises exceptions with slightly more informative message strings (useful for API)

return: string File key

dieRecoverableError( $error, $parameter, $data = array()   X-Ref
Throw an error that the user can recover from by providing a better
value for $parameter

param: array $error Error array suitable for passing to dieUsageMsg()
param: string $parameter Parameter that needs revising
param: array $data Optional extra data to pass to the user

selectUploadModule()   X-Ref
Select an upload module and set it to mUpload. Dies on failure. If the
request was a status request and not a true upload, returns false;
otherwise true

return: bool

checkPermissions( $user )   X-Ref
Checks that the user has permissions to perform this upload.
Dies with usage message on inadequate permissions.

param: User $user The user to check.

verifyUpload()   X-Ref
Performs file verification, dies on error.


checkVerification( array $verification )   X-Ref
Performs file verification, dies on error.

param: array $verification

getApiWarnings()   X-Ref
Check warnings.
Returns a suitable array for inclusion into API results if there were warnings
Returns the empty array if there were no warnings

return: array

transformWarnings( $warnings )   X-Ref
No description

performUpload( $warnings )   X-Ref
Perform the actual upload. Returns a suitable result array on success;
dies on failure.

param: array $warnings Array of Api upload warnings
return: array

checkAsyncDownloadEnabled()   X-Ref
Checks if asynchronous copy uploads are enabled and throws an error if they are not.


mustBePosted()   X-Ref
No description

isWriteMode()   X-Ref
No description

getAllowedParams()   X-Ref
No description

getParamDescription()   X-Ref
No description

getDescription()   X-Ref
No description

needsToken()   X-Ref
No description

getExamples()   X-Ref
No description

getHelpUrls()   X-Ref
No description



Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1