ApiEditPage Class Reference
[API]

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

Inherits ApiBase.

List of all members.

Public Member Functions

 __construct ($query, $moduleName)
 execute ()
 Evaluates the parameters, performs the requested query, and sets up the result.
 mustBePosted ()
 Indicates whether this module must be called with a POST request.
 isWriteMode ()
 Indicates whether this module requires write mode.
 getVersion ()
 Returns a string that identifies the version of the extending class.

Protected Member Functions

 getDescription ()
 Returns the description string for this module.
 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.
 getParamDescription ()
 Returns an array of parameter descriptions.
 getExamples ()
 Returns usage examples for this module.


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


Constructor & Destructor Documentation

ApiEditPage::__construct ( query,
moduleName 
)

Definition at line 40 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 44 of file ApiEditPage.php.

References $result, $section, $wgMaxArticleSize, $wgRequest, $wgTitle, $wgUser, 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_TEXTBOX_EMPTY, Revision::DELETED_TEXT, ApiBase::dieUsage(), ApiBase::dieUsageMsg(), ApiBase::extractRequestParams(), ApiBase::getModuleName(), ApiBase::getResult(), Title::newFromText(), wfMsgForContent(), wfRunHooks(), and wfTimestamp().

ApiEditPage::getAllowedParams (  )  [protected]

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

Reimplemented from ApiBase.

Definition at line 290 of file ApiEditPage.php.

References ApiBase::PARAM_TYPE.

ApiEditPage::getDescription (  )  [protected]

Returns the description string for this module.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 286 of file ApiEditPage.php.

ApiEditPage::getExamples (  )  [protected]

Returns usage examples for this module.

Return null if no examples are available.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 354 of file ApiEditPage.php.

ApiEditPage::getParamDescription (  )  [protected]

Returns an array of parameter descriptions.

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

Returns:
array

Reimplemented from ApiBase.

Definition at line 321 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 365 of file ApiEditPage.php.

ApiEditPage::isWriteMode (  ) 

Indicates whether this module requires write mode.

Returns:
bool

Reimplemented from ApiBase.

Definition at line 282 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 278 of file ApiEditPage.php.


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

Generated on Sat Sep 5 02:08:30 2009 for MediaWiki by  doxygen 1.5.9