ApiImport Class Reference

API module that imports an XML file like Special:Import does. More...

Inheritance diagram for ApiImport:

Collaboration diagram for ApiImport:

List of all members.

Public Member Functions
	__construct ($main, $action)
	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.
	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.
	getVersion ()
	Returns a string that identifies the version of the extending class.
	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.

---

Detailed Description

API module that imports an XML file like Special:Import does.

Definition at line 32 of file ApiImport.php.

---

Constructor & Destructor Documentation

ApiImport::__construct	(	$	main,
		$	action
	)

Definition at line 34 of file ApiImport.php.

---

Member Function Documentation

ApiImport::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 38 of file ApiImport.php.

References $result, $user, ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), ApiBase\getModuleName(), ApiBase\getResult(), ContextSource\getUser(), ImportStreamSource\newFromInterwiki(), and ImportStreamSource\newFromUpload().

Here is the call graph for this function:

ApiImport::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.

Returns:

array or false

Reimplemented from ApiBase.

Definition at line 98 of file ApiImport.php.

References $wgImportSources, and ApiBase\PARAM_TYPE.

ApiImport::getDescription

(

)

Returns the description string for this module.

Returns:

mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 129 of file ApiImport.php.

ApiImport::getExamples

(

)

Returns usage examples for this module.

Return false if no examples are available.

Returns:

false|string|array

Reimplemented from ApiBase.

Definition at line 155 of file ApiImport.php.

ApiImport::getHelpUrls

(

)

Returns:

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

Reimplemented from ApiBase.

Definition at line 162 of file ApiImport.php.

ApiImport::getParamDescription

(

)

Returns an array of parameter descriptions.

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

Returns:

array or false

Reimplemented from ApiBase.

Definition at line 116 of file ApiImport.php.

ApiImport::getPossibleErrors

(

)

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

Returns:

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

Reimplemented from ApiBase.

Definition at line 137 of file ApiImport.php.

ApiImport::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.

Returns:

bool|string

Reimplemented from ApiBase.

Definition at line 151 of file ApiImport.php.

ApiImport::getVersion

(

)

Returns a string that identifies the version of the extending class.

Typically includes the class name, the svn revision, timestamp, and last author. Usually done with SVN's Id keyword

Returns:

string

Reimplemented from ApiBase.

Definition at line 166 of file ApiImport.php.

ApiImport::isWriteMode

(

)

Indicates whether this module requires write mode.

Returns:

bool

Reimplemented from ApiBase.

Definition at line 94 of file ApiImport.php.

ApiImport::mustBePosted

(

)

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

Returns:

bool

Reimplemented from ApiBase.

Definition at line 90 of file ApiImport.php.

ApiImport::needsToken

(

)

Returns whether this module requires a Token to execute.

Returns:

bool

Reimplemented from ApiBase.

Definition at line 147 of file ApiImport.php.

---

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

• includes/api/ApiImport.php