ApiRsd Class Reference
API module for sending out RSD information. More...
Inheritance diagram for ApiRsd:
Collaboration diagram for ApiRsd:
Public Member Functions | |
| execute () | |
| Evaluates the parameters, performs the requested query, and sets up the result. | |
| 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. | |
| isReadMode () | |
| Indicates whether this module requires read rights. | |
 Public Member Functions inherited from ApiBase | |
| __construct (ApiMain $mainModule, $moduleName, $modulePrefix='') | |
| setWarning ( $warning) | |
| Set warning section for this module. | |
| 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. | |
| 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. | |
| getErrorFromStatus ( $status, &$extraData=null) | |
| Get error (as code, string) from a Status object. | |
| dieStatus ( $status) | |
| Throw a UsageException based on the errors in the Status object. | |
| dieReadOnly () | |
| Helper function for readonly errors. | |
| dieUsageMsg ( $error) | |
| Output the error message related to a certain array. | |
| dieUsageMsgOrDebug ( $error) | |
| Will only set a warning instead of failing if the global $wgDebugAPI is set to true. | |
| parseMsg ( $error) | |
| Return the error message related to a certain array. | |
| logFeatureUsage ( $feature) | |
| Write logging information for API features to a debug log, for usage analysis. | |
| getModuleManager () | |
| Get the module manager, or null if this module has no sub-modules. | |
| getHelpUrls () | |
| Return links to more detailed help pages about the module. | |
| shouldCheckMaxlag () | |
| Indicates if this module needs maxlag to be checked. | |
| isWriteMode () | |
| Indicates whether this module requires write mode. | |
| mustBePosted () | |
| Indicates whether this module must be called with a POST request. | |
| isDeprecated () | |
| Indicates whether this module is deprecated. | |
| isInternal () | |
| Indicates whether this module is "internal" Internal API modules are not (yet) intended for 3rd party use and may be unstable. | |
| needsToken () | |
| Returns the token type this module requires in order to execute. | |
| getConditionalRequestData ( $condition) | |
| Returns data for HTTP conditional request mechanisms. | |
| getModuleName () | |
| Get the name of the module being executed by this instance. | |
| getModulePrefix () | |
| Get parameter prefix (usually two letters or an empty string). | |
| getMain () | |
| Get the main module. | |
| isMain () | |
| Returns true if this module is the main module ($this === $this->mMainModule), false otherwise. | |
| getParent () | |
| Get the parent of this module. | |
| lacksSameOriginSecurity () | |
| Returns true if the current request breaks the same-origin policy. | |
| getModulePath () | |
| Get the path to this module. | |
| getModuleFromPath ( $path) | |
| Get a module from its module path. | |
| getResult () | |
| Get the result object. | |
| getErrorFormatter () | |
| Get the error formatter. | |
| getContinuationManager () | |
| Get the continuation manager. | |
| setContinuationManager ( $manager) | |
| Set the continuation manager. | |
| dynamicParameterDocumentation () | |
| Indicate if the module supports dynamically-determined parameters that cannot be included in self::getAllowedParams(). | |
| encodeParamName ( $paramName) | |
| This method mangles parameter name based on the prefix supplied to the constructor. | |
| 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. | |
| requireOnlyOneParameter ( $params, $required) | |
| Die if none or more than one of a certain set of parameters is set and not false. | |
| requireMaxOneParameter ( $params, $required) | |
| Die if more than one of a certain set of parameters is set and not false. | |
| requireAtLeastOneParameter ( $params, $required) | |
| Die if none of a certain set of parameters is set and not false. | |
| requirePostedParameters ( $params, $prefix='prefix') | |
| Die if any of the specified parameters were found in the query part of the URL rather than the post body. | |
| getTitleOrPageId ( $params, $load=false) | |
| Get a WikiPage object from a title or pageid param, if possible. | |
| validateToken ( $token, array $params) | |
| Validate the supplied token. | |
| getWatchlistUser ( $params) | |
| Gets the user for whom to get the watchlist. | |
| getFinalDescription () | |
| Get final module description, after hooks have had a chance to tweak it as needed. | |
| getFinalParams ( $flags=0) | |
| Get final list of parameters, after hooks have had a chance to tweak it as needed. | |
| getFinalParamDescription () | |
| Get final parameter descriptions, after hooks have had a chance to tweak it as needed. | |
| modifyHelp (array &$help, array $options, array &$tocData) | |
| Called from ApiHelp before the pieces are joined together and returned. | |
| getModuleProfileName ( $db=false) | |
| profileIn () | |
| profileOut () | |
| safeProfileOut () | |
| getProfileTime () | |
| profileDBIn () | |
| profileDBOut () | |
| getProfileDBTime () | |
| Public Member Functions inherited from ContextSource | |
| canUseWikiPage () | |
| Check whether a WikiPage object can be get with getWikiPage(). | |
| exportSession () | |
| Export the resolved user IP, HTTP headers, user ID, and session ID. | |
| getConfig () | |
| Get the Config object. | |
| getContext () | |
| Get the base IContextSource object. | |
| getLanguage () | |
| Get the Language object. | |
| getOutput () | |
| Get the OutputPage object. | |
| getRequest () | |
| Get the WebRequest object. | |
| getSkin () | |
| Get the Skin object. | |
| getStats () | |
| Get the Stats object. | |
| getTiming () | |
| Get the Timing object. | |
| getTitle () | |
| Get the Title object. | |
| getUser () | |
| Get the User object. | |
| getWikiPage () | |
| Get the WikiPage object. | |
| msg () | |
| Get a Message object with context set Parameters are the same as wfMessage() | |
| setContext (IContextSource $context) | |
| Set the IContextSource object. | |
Protected Member Functions | |
| formatRsdApiList () | |
| Formats the internal list of exposed APIs into an array suitable to pass to the API's XML formatter. | |
| getExamplesMessages () | |
| Returns usage examples for this module. | |
| getRsdApiList () | |
| Builds an internal list of APIs to expose information about. | |
| Protected Member Functions inherited from ApiBase | |
| dieContinueUsageIf ( $condition) | |
| Die with the $prefix. | |
| 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. | |
| getWebUITokenSalt (array $params) | |
| Fetch the salt used in the Web UI corresponding to this module. | |
| getDB () | |
| Gets a default replica DB connection object. | |
| getParameter ( $paramName, $parseLimit=true) | |
| Get a value for the given parameter. | |
| getWatchlistValue ( $watchlist, $titleObj, $userOption=null) | |
| Return true if we're to watch the page, false if not, null if no change. | |
| getParameterFromSettings ( $paramName, $paramSettings, $parseLimit) | |
| Using the settings determine the value for the given parameter. | |
| handleParamNormalization ( $paramName, $value, $rawValue) | |
| Handle when a parameter was Unicode-normalized. | |
| explodeMultiValue ( $value, $limit) | |
| Split a multi-valued parameter string, like explode() | |
| parseMultiValue ( $valueName, $value, $allowMultiple, $allowedValues) | |
| Return an array of values that were given in a 'a|b|c' notation, after it optionally validates them against the list allowed values. | |
| validateLimit ( $paramName, &$value, $min, $max, $botMax=null, $enforceLimits=false) | |
| Validate the value against the minimum and user/bot maximum limits. | |
| validateTimestamp ( $value, $encParamName) | |
| Validate and normalize of parameters of type 'timestamp'. | |
| setWatch ( $watch, $titleObj, $userOption=null) | |
| Set a watch (or unwatch) based the based on a watchlist parameter. | |
| getDescriptionMessage () | |
| Return the description message. | |
| getHelpFlags () | |
| Generates the list of flags for the help screen and for action=paraminfo. | |
| getModuleSourceInfo () | |
| Returns information about the source of this module, if known. | |
| getDescription () | |
| Returns the description string for this module. | |
| getParamDescription () | |
| Returns an array of parameter descriptions. | |
| getExamples () | |
| Returns usage examples for this module. | |
| useTransactionalTimeLimit () | |
| Call wfTransactionalTimeLimit() if this request was POSTed. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from ApiBase | |
| static | truncateArray (&$arr, $limit) |
| Truncate an array to a certain length. | |
| static | makeMessage ( $msg, IContextSource $context, array $params=null) |
| Create a Message from a string or array. | |
| Public Attributes inherited from ApiBase | |
| const | GET_VALUES_FOR_HELP = 1 |
| getAllowedParams() flag: When set, the result could take longer to generate, but should be more thorough. | |
| const | LIMIT_BIG1 = 500 |
| Fast query, standard limit. | |
| const | LIMIT_BIG2 = 5000 |
| Fast query, apihighlimits limit. | |
| const | LIMIT_SML1 = 50 |
| Slow query, standard limit. | |
| const | LIMIT_SML2 = 500 |
| Slow query, apihighlimits limit. | |
| const | PARAM_DFLT = 0 |
| (null|boolean|integer|string) Default value of the parameter. | |
| const | PARAM_ISMULTI = 1 |
| (boolean) Accept multiple pipe-separated values for this parameter (e.g. | |
| const | PARAM_TYPE = 2 |
| (string|string[]) Either an array of allowed value strings, or a string type as described below. | |
| const | PARAM_MAX = 3 |
| (integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'. | |
| const | PARAM_MAX2 = 4 |
| (integer) Max value allowed for the parameter for users with the apihighlimits right, for PARAM_TYPE 'limit'. | |
| const | PARAM_MIN = 5 |
| (integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'. | |
| const | PARAM_ALLOW_DUPLICATES = 6 |
| (boolean) Allow the same value to be set more than once when PARAM_ISMULTI is true? | |
| const | PARAM_DEPRECATED = 7 |
| (boolean) Is the parameter deprecated (will show a warning)? | |
| const | PARAM_REQUIRED = 8 |
| (boolean) Is the parameter required? | |
| const | PARAM_RANGE_ENFORCE = 9 |
| (boolean) For PARAM_TYPE 'integer', enforce PARAM_MIN and PARAM_MAX? | |
| const | PARAM_HELP_MSG = 10 |
| (string|array|Message) Specify an alternative i18n documentation message for this parameter. | |
| const | PARAM_HELP_MSG_APPEND = 11 |
| ((string|array|Message)[]) Specify additional i18n messages to append to the normal message for this parameter. | |
| const | PARAM_HELP_MSG_INFO = 12 |
| (array) Specify additional information tags for the parameter. | |
| const | PARAM_VALUE_LINKS = 13 |
| (string[]) When PARAM_TYPE is an array, this may be an array mapping those values to page titles which will be linked in the help. | |
| const | PARAM_HELP_MSG_PER_VALUE = 14 |
| ((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg for ApiBase::makeMessage(). | |
| const | PARAM_SUBMODULE_MAP = 15 |
| (string[]) When PARAM_TYPE is 'submodule', map parameter values to submodule paths. | |
| const | PARAM_SUBMODULE_PARAM_PREFIX = 16 |
| (string) When PARAM_TYPE is 'submodule', used to indicate the 'g' prefix added by ApiQueryGeneratorBase (and similar if anything else ever does that). | |
| const | PARAM_SENSITIVE = 17 |
| (boolean) Is the parameter sensitive? Note 'password'-type fields are always sensitive regardless of the value of this field. | |
| Static Public Attributes inherited from ApiBase | |
| static | $messageMap |
| Array that maps message keys to error messages. | |
| Static Protected Member Functions inherited from ApiBase | |
| static | dieDebug ( $method, $message) |
| Internal code errors should be reported with this method. | |
Detailed Description
API module for sending out RSD information.
Definition at line 32 of file ApiRsd.php.
Member Function Documentation
◆ execute()
| ApiRsd::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 34 of file ApiRsd.php.
References formatRsdApiList(), ApiBase\getResult(), ApiResult\setIndexedTagName(), and ApiResult\setSubelementsList().
◆ formatRsdApiList()
|
protected |
Formats the internal list of exposed APIs into an array suitable to pass to the API's XML formatter.
- Returns
- array
Definition at line 116 of file ApiRsd.php.
References $name, as, getRsdApiList(), ApiResult\setContentValue(), ApiResult\setIndexedTagName(), ApiResult\setSubelementsList(), and wfBoolToStr().
Referenced by execute().
◆ getCustomPrinter()
| ApiRsd::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.
A value of null means the default format will be used.
- Note
- Do not use this just because you don't want to support non-json formats. This should be used only when there is a fundamental requirement for a specific format.
- Returns
- mixed Instance of a derived class of ApiFormatBase, or null
Reimplemented from ApiBase.
Definition at line 53 of file ApiRsd.php.
References ApiBase\getMain().
◆ getExamplesMessages()
|
protected |
Returns usage examples for this module.
Return value has query strings as keys, with values being either strings (message key), arrays (message key + parameter), or Message objects.
Do not call this base class implementation when overriding this method.
- Since
- 1.25
- Returns
- array
Reimplemented from ApiBase.
Definition at line 57 of file ApiRsd.php.
◆ getRsdApiList()
|
protected |
Builds an internal list of APIs to expose information about.
Normally this only lists the MediaWiki API, with its base URL, link to documentation, and a marker as to available authentication (to aid in OAuth client apps switching to support in the future).
Extensions can expose other APIs, such as WordPress or Twitter- compatible APIs, by hooking 'ApiRsdServiceApis' and adding more elements to the array.
See http://cyber.law.harvard.edu/blogs/gems/tech/rsd.html for the base RSD spec, and check WordPress and StatusNet sites for in-production examples listing several blogging and micrblogging APIs.
- Returns
- array
Definition at line 85 of file ApiRsd.php.
References PROTO_CURRENT, wfExpandUrl(), and wfScript().
Referenced by formatRsdApiList().
◆ isReadMode()
| ApiRsd::isReadMode | ( | ) |
Indicates whether this module requires read rights.
- Returns
- bool
Reimplemented from ApiBase.
Definition at line 64 of file ApiRsd.php.
The documentation for this class was generated from the following file:
- includes/api/ApiRsd.php
