Inheritance diagram for ApiUpload:

Collaboration diagram for ApiUpload:

Public Member Functions
	execute ()
	Evaluates the parameters, performs the requested query, and sets up the result.
	getAllowedParams ()
	Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed.
	getDescription ()
	Returns the description string for this module.
	getExamples ()
	Returns usage examples for this module.
	getHelpUrls ()
	getParamDescription ()
	Returns an array of parameter descriptions.
	getPossibleErrors ()
	Returns a list of all possible errors returned by the module.
	getResultProperties ()
	Returns possible properties in the result, grouped by the value of the prop parameter that shows them.
	getTokenSalt ()
	Returns the token salt if there is one, '' if the module doesn't require a salt, else false if the module doesn't need a token You have also to override needsToken() Value is passed to User::getEditToken.
	isWriteMode ()
	Indicates whether this module requires write mode.
	mustBePosted ()
	Indicates whether this module must be called with a POST request.
	needsToken ()
	Returns whether this module requires a token to execute It is used to show possible errors in action=paraminfo see bug 25248.
Protected Member Functions
	checkAsyncDownloadEnabled ()
	Checks if asynchronous copy uploads are enabled and throws an error if they are not.
	checkPermissions ($user)
	Checks that the user has permissions to perform this upload.
	checkVerification (array $verification)
	Performs file verification, dies on error.
	getApiWarnings ()
	Check warnings.
	performUpload ($warnings)
	Perform the actual upload.
	selectUploadModule ()
	Select an upload module and set it to mUpload.
	transformWarnings ($warnings)
	verifyUpload ()
	Performs file verification, dies on error.
Protected Attributes
	$mParams
UploadBase	$mUpload = null
	*
Private Member Functions
	dieRecoverableError ($error, $parameter, $data=array())
	Throw an error that the user can recover from by providing a better value for $parameter.
	getChunkResult ($warnings)
	Get the result of a chunk upload.
	getContextResult ()
	Get an upload result based on upload context.
	getStashResult ($warnings)
	Get Stash Result, throws an exception if the file could not be stashed.
	getWarningsResult ($warnings)
	Get Warnings Result.
	performStash ()
	Stash the file and return the file key Also re-raises exceptions with slightly more informative message strings (useful for API)

Detailed Description

Definition at line 30 of file ApiUpload.php.

Member Function Documentation

ApiUpload::checkAsyncDownloadEnabled ( ) [protected]

Checks if asynchronous copy uploads are enabled and throws an error if they are not.

Definition at line 679 of file ApiUpload.php.

ApiUpload::checkPermissions ( $ user ) [protected]

Checks that the user has permissions to perform this upload.

Dies with usage message on inadequate permissions.

Parameters:

$user User The user to check.

Definition at line 450 of file ApiUpload.php.

Referenced by execute().

ApiUpload::checkVerification ( array $ verification ) [protected]

Performs file verification, dies on error.

Definition at line 478 of file ApiUpload.php.

ApiUpload::dieRecoverableError	(	$	error,
		$	parameter,
		$	data = `array()`
	)		`[private]`

Throw an error that the user can recover from by providing a better value for $parameter.

Parameters:

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

Exceptions:

UsageException

Definition at line 305 of file ApiUpload.php.

Referenced by execute().

ApiUpload::execute ( )

Evaluates the parameters, performs the requested query, and sets up the result.

Concrete implementations of ApiBase must override this method to provide whatever functionality their module offers. Implementations must not produce any output on their own and are not expected to handle any errors.

The execute() method will be invoked directly by ApiMain immediately before the result of the module is output. Aside from the constructor, implementations should assume that no other methods will be called externally on the module before the result is processed.

The result data should be stored in the ApiResult object available through getResult().

Reimplemented from ApiBase.

Definition at line 35 of file ApiUpload.php.

References $e, $error, $result, $user, checkPermissions(), dieRecoverableError(), ApiBase\dieUsage(), ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), getContextResult(), ApiBase\getMain(), ApiBase\getModuleName(), ApiBase\getResult(), ContextSource\getUser(), global, UploadBase\isEnabled(), selectUploadModule(), verifyUpload(), and wfDebug().

ApiUpload::getAllowedParams ( )

Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed.

Some derived classes may choose to handle an integer $flags parameter in the overriding methods. Callers of this method can pass zero or more OR-ed flags like GET_VALUES_FOR_HELP.

Returns:: array|bool

Reimplemented from ApiBase.

Definition at line 694 of file ApiUpload.php.

References $params, array(), ApiBase\PARAM_DEPRECATED, ApiBase\PARAM_DFLT, ApiBase\PARAM_REQUIRED, and ApiBase\PARAM_TYPE.

ApiUpload::getApiWarnings ( ) [protected]

Check warnings.

Returns a suitable array for inclusion into API results if there were warnings Returns the empty array if there were no warnings

Returns:: array

Definition at line 549 of file ApiUpload.php.

ApiUpload::getChunkResult ( $ warnings ) [private]

Get the result of a chunk upload.

Parameters:

array $warnings Array of Api upload warnings

Returns:: array

Definition at line 195 of file ApiUpload.php.

ApiUpload::getContextResult ( ) [private]

Get an upload result based on upload context.

Returns:: array

Definition at line 128 of file ApiUpload.php.

Referenced by execute().

ApiUpload::getDescription ( )

Returns the description string for this module.

Returns:: mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 814 of file ApiUpload.php.

References array().

ApiUpload::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:: bool|string|array

Reimplemented from ApiBase.

Definition at line 859 of file ApiUpload.php.

References array().

ApiUpload::getHelpUrls ( )

Returns:: bool|string|array Returns a false if the module has no help URL, else returns a (array of) string

Reimplemented from ApiBase.

Definition at line 869 of file ApiUpload.php.

ApiUpload::getParamDescription ( )

Returns an array of parameter descriptions.

Don't call this function directly: use getFinalParamDescription() to allow hooks to modify descriptions as needed.

Returns:: array|bool False on no parameter descriptions

Reimplemented from ApiBase.

Definition at line 747 of file ApiUpload.php.

References $params, and array().

ApiUpload::getPossibleErrors ( )

Returns a list of all possible errors returned by the module.

Don't call this function directly: use getFinalPossibleErrors() to allow hooks to modify parameters as needed.

Returns:: array in the format of array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )

Reimplemented from ApiBase.

Definition at line 825 of file ApiUpload.php.

References array(), and ApiBase\getRequireOnlyOneParameterErrorMessages().

ApiUpload::getResultProperties ( )

Returns possible properties in the result, grouped by the value of the prop parameter that shows them.

Properties that are shown always are in a group with empty string as a key. Properties that can be shown by several values of prop are included multiple times. If some properties are part of a list and some are on the root object (see ApiQueryQueryPage), those on the root object are under the key PROP_ROOT. The array can also contain a boolean under the key PROP_LIST, indicating whether the result is a list.

Don't call this function directly: use getFinalResultProperties() to allow hooks to modify descriptions as needed.

Returns:: array|bool False on no properties

Reimplemented from ApiBase.

Definition at line 779 of file ApiUpload.php.

References array(), ApiBase\PROP_NULLABLE, and ApiBase\PROP_TYPE.

ApiUpload::getStashResult ( $ warnings ) [private]

Get Stash Result, throws an exception if the file could not be stashed.

Parameters:

array $warnings Array of Api upload warnings

Returns:: array

Definition at line 151 of file ApiUpload.php.

ApiUpload::getTokenSalt ( )

Returns the token salt if there is one, '' if the module doesn't require a salt, else false if the module doesn't need a token You have also to override needsToken() Value is passed to User::getEditToken.

Returns:: bool|string|array

Reimplemented from ApiBase.

Definition at line 855 of file ApiUpload.php.

ApiUpload::getWarningsResult ( $ warnings ) [private]

Get Warnings Result.

Parameters:

array $warnings Array of Api upload warnings

Returns:: array

Definition at line 174 of file ApiUpload.php.

ApiUpload::isWriteMode ( )

Indicates whether this module requires write mode.

Returns:: bool

Reimplemented from ApiBase.

Definition at line 690 of file ApiUpload.php.

ApiUpload::mustBePosted ( )

Indicates whether this module must be called with a POST request.

Returns:: bool

Reimplemented from ApiBase.

Definition at line 686 of file ApiUpload.php.

ApiUpload::needsToken ( )

Returns whether this module requires a token to execute It is used to show possible errors in action=paraminfo see bug 25248.

Returns:: bool

Reimplemented from ApiBase.

Definition at line 851 of file ApiUpload.php.

ApiUpload::performStash ( ) [private]

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

Exceptions:

MWException

Returns:: String file key

Definition at line 279 of file ApiUpload.php.

ApiUpload::performUpload ( $ warnings ) [protected]

Perform the actual upload.

Returns a suitable result array on success; dies on failure.

Parameters:

array $warnings Array of Api upload warnings

Returns:: array

Definition at line 590 of file ApiUpload.php.

ApiUpload::selectUploadModule ( ) [protected]

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

Returns:: bool

Definition at line 325 of file ApiUpload.php.

Referenced by execute().

ApiUpload::transformWarnings ( $ warnings ) [protected]

Definition at line 555 of file ApiUpload.php.

References $result, array(), as, and ApiBase\getResult().

ApiUpload::verifyUpload ( ) [protected]

Performs file verification, dies on error.

Definition at line 466 of file ApiUpload.php.

Referenced by execute().

Member Data Documentation

ApiUpload::$mParams [protected]

Definition at line 33 of file ApiUpload.php.

UploadBase ApiUpload::$mUpload = null [protected]

*

Definition at line 31 of file ApiUpload.php.

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

includes/api/ApiUpload.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Function Documentation

Member Data Documentation