A module that allows for editing and creating pages. More...
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. | |
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.
Member Function Documentation
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 36 of file ApiEditPage.php.
References $name, $oldTitle, $params, $result, $section, $titles, $user, $wgTitle, array(), as, 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_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_PARSE_ERROR, 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(), WikiPage\factory(), Revision\FOR_THIS_USER, ContentHandler\getForModelID(), ApiBase\getModuleName(), ContextSource\getRequest(), ApiBase\getResult(), ContextSource\getTitle(), ApiBase\getTitleOrPageId(), ContextSource\getUser(), ApiBase\getWatchlistValue(), global, list, ContentHandler\makeContent(), Revision\newFromTitle(), Article\newFromWikiPage(), IDBAccessObject\READ_LATEST, RequestContext\setRequest(), wfMessage(), wfRunHooks(), wfTimestamp(), and wfTimestampNow().
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 527 of file ApiEditPage.php.
References array(), ContentHandler\getAllContentFormats(), ContentHandler\getContentModels(), ApiBase\PARAM_DEPRECATED, ApiBase\PARAM_DFLT, ApiBase\PARAM_REQUIRED, and ApiBase\PARAM_TYPE.
Returns the description string for this module.
- Returns:
- mixed string or array of strings
Reimplemented from ApiBase.
Definition at line 477 of file ApiEditPage.php.
Returns usage examples for this module.
Return false if no examples are available.
- Returns:
- bool|string|array
Reimplemented from ApiBase.
Definition at line 675 of file ApiEditPage.php.
References array().
- 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 686 of file ApiEditPage.php.
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 592 of file ApiEditPage.php.
References array(), and ApiBase\getModulePrefix().
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 481 of file ApiEditPage.php.
References array(), ApiBase\getTitleOrPageIdErrorMessage(), and global.
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 632 of file ApiEditPage.php.
References array(), ApiBase\PROP_NULLABLE, and ApiBase\PROP_TYPE.
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 671 of file ApiEditPage.php.
Indicates whether this module requires write mode.
- Returns:
- bool
Reimplemented from ApiBase.
Definition at line 473 of file ApiEditPage.php.
Indicates whether this module must be called with a POST request.
- Returns:
- bool
Reimplemented from ApiBase.
Definition at line 469 of file ApiEditPage.php.
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 667 of file ApiEditPage.php.
The documentation for this class was generated from the following file:
- includes/api/ApiEditPage.php
