|
| | __construct () |
| |
| | execute () |
| |
| | getAllowedParams () |
| |
| | __construct (ApiMain $mainModule, $moduleName, $modulePrefix= '') |
| |
| | execute () |
| | Evaluates the parameters, performs the requested query, and sets up the result. More...
|
| |
| | getModuleManager () |
| | Get the module manager, or null if this module has no sub-modules. More...
|
| |
| | getCustomPrinter () |
| | If the module may only be used with a certain format module, it should override this method to return an instance of that formatter. More...
|
| |
| | getHelpUrls () |
| | Return links to more detailed help pages about the module. More...
|
| |
| | shouldCheckMaxlag () |
| | Indicates if this module needs maxlag to be checked. More...
|
| |
| | isReadMode () |
| | Indicates whether this module requires read rights. More...
|
| |
| | isWriteMode () |
| | Indicates whether this module requires write mode. More...
|
| |
| | mustBePosted () |
| | Indicates whether this module must be called with a POST request. More...
|
| |
| | isDeprecated () |
| | Indicates whether this module is deprecated. More...
|
| |
| | isInternal () |
| | Indicates whether this module is "internal" Internal API modules are not (yet) intended for 3rd party use and may be unstable. More...
|
| |
| | needsToken () |
| | Returns the token type this module requires in order to execute. More...
|
| |
| | getConditionalRequestData ($condition) |
| | Returns data for HTTP conditional request mechanisms. More...
|
| |
| | getModuleName () |
| | Get the name of the module being executed by this instance. More...
|
| |
| | getModulePrefix () |
| | Get parameter prefix (usually two letters or an empty string). More...
|
| |
| | getMain () |
| | Get the main module. More...
|
| |
| | isMain () |
| | Returns true if this module is the main module ($this === $this->mMainModule), false otherwise. More...
|
| |
| | getParent () |
| | Get the parent of this module. More...
|
| |
| | lacksSameOriginSecurity () |
| | Returns true if the current request breaks the same-origin policy. More...
|
| |
| | getModulePath () |
| | Get the path to this module. More...
|
| |
| | getModuleFromPath ($path) |
| | Get a module from its module path. More...
|
| |
| | getResult () |
| | Get the result object. More...
|
| |
| | getErrorFormatter () |
| | Get the error formatter. More...
|
| |
| | getContinuationManager () |
| | Get the continuation manager. More...
|
| |
| | setContinuationManager ($manager) |
| | Set the continuation manager. More...
|
| |
| | dynamicParameterDocumentation () |
| | Indicate if the module supports dynamically-determined parameters that cannot be included in self::getAllowedParams(). More...
|
| |
| | encodeParamName ($paramName) |
| | This method mangles parameter name based on the prefix supplied to the constructor. More...
|
| |
| | extractRequestParams ($parseLimit=true) |
| | Using getAllowedParams(), this function makes an array of the values provided by the user, with key being the name of the variable, and value - validated value from user or default. More...
|
| |
| | requireOnlyOneParameter ($params, $required) |
| | Die if none or more than one of a certain set of parameters is set and not false. More...
|
| |
| | requireMaxOneParameter ($params, $required) |
| | Die if more than one of a certain set of parameters is set and not false. More...
|
| |
| | requireAtLeastOneParameter ($params, $required) |
| | Die if none of a certain set of parameters is set and not false. More...
|
| |
| | getTitleOrPageId ($params, $load=false) |
| | Get a WikiPage object from a title or pageid param, if possible. More...
|
| |
| | validateToken ($token, array $params) |
| | Validate the supplied token. More...
|
| |
| | getWatchlistUser ($params) |
| | Gets the user for whom to get the watchlist. More...
|
| |
| | setWarning ($warning) |
| | Set warning section for this module. More...
|
| |
| | dieUsage ($description, $errorCode, $httpRespCode=0, $extradata=null) |
| | Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an error message. More...
|
| |
| | dieBlocked (Block $block) |
| | Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an error message including block info. More...
|
| |
| | getErrorFromStatus ($status, &$extraData=null) |
| | Get error (as code, string) from a Status object. More...
|
| |
| | dieStatus ($status) |
| | Throw a UsageException based on the errors in the Status object. More...
|
| |
| static | dieReadOnly () |
| | Helper function for readonly errors. More...
|
| |
| | dieUsageMsg ($error) |
| | Output the error message related to a certain array. More...
|
| |
| | dieUsageMsgOrDebug ($error) |
| | Will only set a warning instead of failing if the global $wgDebugAPI is set to true. More...
|
| |
| | parseMsg ($error) |
| | Return the error message related to a certain array. More...
|
| |
| | getFinalDescription () |
| | Get final module description, after hooks have had a chance to tweak it as needed. More...
|
| |
| | getFinalParams ($flags=0) |
| | Get final list of parameters, after hooks have had a chance to tweak it as needed. More...
|
| |
| | getFinalParamDescription () |
| | Get final parameter descriptions, after hooks have had a chance to tweak it as needed. More...
|
| |
| | modifyHelp (array &$help, array $options, array &$tocData) |
| | Called from ApiHelp before the pieces are joined together and returned. More...
|
| |
| | makeHelpMsg () |
| | Generates help message for this module, or false if there is no description. More...
|
| |
| | makeHelpMsgParameters () |
| | Generates the parameter descriptions for this module, to be displayed in the module's help. More...
|
| |
| | getModuleProfileName ($db=false) |
| |
| | profileIn () |
| |
| | profileOut () |
| |
| | safeProfileOut () |
| |
| | getProfileTime () |
| |
| | profileDBIn () |
| |
| | profileDBOut () |
| |
| | getProfileDBTime () |
| |
| | getResultData () |
| | Get the result data array (read-only) More...
|
| |
| | canUseWikiPage () |
| | Check whether a WikiPage object can be get with getWikiPage(). More...
|
| |
| | exportSession () |
| | Export the resolved user IP, HTTP headers, user ID, and session ID. More...
|
| |
| | getConfig () |
| | Get the Config object. More...
|
| |
| | getContext () |
| | Get the base IContextSource object. More...
|
| |
| | getLanguage () |
| | Get the Language object. More...
|
| |
| | getOutput () |
| | Get the OutputPage object. More...
|
| |
| | getRequest () |
| | Get the WebRequest object. More...
|
| |
| | getSkin () |
| | Get the Skin object. More...
|
| |
| | getStats () |
| | Get the Stats object. More...
|
| |
| | getTiming () |
| | Get the Timing object. More...
|
| |
| | getTitle () |
| | Get the Title object. More...
|
| |
| | getUser () |
| | Get the User object. More...
|
| |
| | getWikiPage () |
| | Get the WikiPage object. More...
|
| |
| | msg () |
| | Get a Message object with context set Parameters are the same as wfMessage() More...
|
| |
| | setContext (IContextSource $context) |
| | Set the IContextSource object. More...
|
| |
Public Member Functions inherited from ApiBase
1.8.6