A module that allows for editing and creating pages. More...

Inheritance diagram for ApiEditPage:

Collaboration diagram for ApiEditPage:

Public Member Functions
	__construct ($query, $moduleName)
	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

A module that allows for editing and creating pages.

Currently, this wraps around the EditPage class in an ugly way, EditPage.php should be rewritten to provide a cleaner interface

Definition at line 34 of file ApiEditPage.php.

Constructor & Destructor Documentation

ApiEditPage::__construct	(	$	query,
		$	moduleName
	)

Definition at line 36 of file ApiEditPage.php.

Member Function Documentation

ApiEditPage::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 40 of file ApiEditPage.php.

References $result, $section, $user, $wgMaxArticleSize, $wgParser, $wgTitle, EditPage\AS_ARTICLE_WAS_DELETED, EditPage\AS_BLANK_ARTICLE, EditPage\AS_BLOCKED_PAGE_FOR_USER, EditPage\AS_CONFLICT_DETECTED, EditPage\AS_CONTENT_TOO_BIG, EditPage\AS_END, EditPage\AS_FILTERING, EditPage\AS_HOOK_ERROR, EditPage\AS_HOOK_ERROR_EXPECTED, EditPage\AS_IMAGE_REDIRECT_ANON, EditPage\AS_IMAGE_REDIRECT_LOGGED, EditPage\AS_MAX_ARTICLE_SIZE_EXCEEDED, EditPage\AS_NO_CREATE_PERMISSION, EditPage\AS_RATE_LIMITED, EditPage\AS_READ_ONLY_PAGE, EditPage\AS_READ_ONLY_PAGE_ANON, EditPage\AS_READ_ONLY_PAGE_LOGGED, EditPage\AS_SPAM_ERROR, EditPage\AS_SUCCESS_NEW_ARTICLE, EditPage\AS_SUCCESS_UPDATE, EditPage\AS_SUMMARY_NEEDED, EditPage\AS_TEXTBOX_EMPTY, Revision\DELETED_TEXT, ApiBase\dieReadOnly(), ApiBase\dieUsage(), ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), Revision\FOR_THIS_USER, ContextSource\getContext(), ApiBase\getModuleName(), ContextSource\getRequest(), ApiBase\getResult(), ContextSource\getUser(), ApiBase\getWatchlistValue(), Title\newFromRedirectArray(), Title\newFromText(), Revision\newFromTitle(), Article\newFromTitle(), wfMsgForContent(), wfRunHooks(), wfTimestamp(), and wfTimestampNow().

Here is the call graph for this function:

ApiEditPage::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 408 of file ApiEditPage.php.

References ApiBase\PARAM_DEPRECATED, ApiBase\PARAM_DFLT, ApiBase\PARAM_REQUIRED, and ApiBase\PARAM_TYPE.

ApiEditPage::getDescription ( )

Returns the description string for this module.

Returns:: mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 367 of file ApiEditPage.php.

ApiEditPage::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:: false|string|array

Reimplemented from ApiBase.

Definition at line 507 of file ApiEditPage.php.

ApiEditPage::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 520 of file ApiEditPage.php.

ApiEditPage::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 463 of file ApiEditPage.php.

References ApiBase\getModulePrefix().

Here is the call graph for this function:

ApiEditPage::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 371 of file ApiEditPage.php.

References $wgMaxArticleSize.

ApiEditPage::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 503 of file ApiEditPage.php.

ApiEditPage::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 524 of file ApiEditPage.php.

ApiEditPage::isWriteMode ( )

Indicates whether this module requires write mode.

Returns:: bool

Reimplemented from ApiBase.

Definition at line 363 of file ApiEditPage.php.

ApiEditPage::mustBePosted ( )

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

Returns:: bool

Reimplemented from ApiBase.

Definition at line 359 of file ApiEditPage.php.

ApiEditPage::needsToken ( )

Returns whether this module requires a Token to execute.

Returns:: bool

Reimplemented from ApiBase.

Definition at line 499 of file ApiEditPage.php.

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

includes/api/ApiEditPage.php

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation