This is the abstract base class for API formatters. More...
Public Member Functions | |
| __construct (ApiMain $main, $format) | |
| If $format ends with 'fm', pretty-print the output in HTML. More... | |
| canPrintErrors () | |
| Whether this formatter can handle printing API errors. More... | |
| closePrinter () | |
| Finish printing and output buffered data. More... | |
| disable () | |
| Disable the formatter. More... | |
| forceDefaultParams () | |
| Ignore request parameters, force a default. More... | |
| getAllowedParams () | |
| getBuffer () | |
| Get the contents of the buffer. More... | |
| getFormat () | |
| Get the internal format name. More... | |
| getHelpUrls () | |
| getIsHtml () | |
| Returns true when the HTML pretty-printer should be used. More... | |
| getMimeType () | |
| Overriding class returns the MIME type that should be sent to the client. More... | |
| initPrinter ($unused=false) | |
| Initialize the printer function and prepare the output headers. More... | |
| isDisabled () | |
| Whether the printer is disabled. More... | |
| printText ($text) | |
| Append text to the output buffer. More... | |
 Public Member Functions inherited from ApiBase | |
| __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... | |
| 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. 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... | |
| logFeatureUsage ($feature) | |
| Write logging information for API features to a debug log, for usage analysis. 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... | |
| 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(). 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 Attributes | |
| $mDisabled = false | |
| $mFormat | |
| $mHelp | |
| $mUnescapeAmps | |
| Public Attributes inherited from ApiBase | |
| string | $mModulePrefix |
| const | GET_VALUES_FOR_HELP = 1 |
| getAllowedParams() flag: When set, the result could take longer to generate, but should be more thorough. More... | |
| const | LIMIT_BIG1 = 500 |
| Fast query, standard limit. More... | |
| const | LIMIT_BIG2 = 5000 |
| Fast query, apihighlimits limit. More... | |
| const | LIMIT_SML1 = 50 |
| Slow query, standard limit. More... | |
| const | LIMIT_SML2 = 500 |
| Slow query, apihighlimits limit. More... | |
| const | PARAM_DFLT = 0 |
| (null|boolean|integer|string) Default value of the parameter. More... | |
| const | PARAM_ISMULTI = 1 |
| (boolean) Accept multiple pipe-separated values for this parameter (e.g. More... | |
| const | PARAM_TYPE = 2 |
| (string|string[]) Either an array of allowed value strings, or a string type as described below. More... | |
| const | PARAM_MAX = 3 |
| (integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'. More... | |
| const | PARAM_MAX2 = 4 |
| (integer) Max value allowed for the parameter for users with the apihighlimits right, for PARAM_TYPE 'limit'. More... | |
| const | PARAM_MIN = 5 |
| (integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'. More... | |
| const | PARAM_ALLOW_DUPLICATES = 6 |
| (boolean) Allow the same value to be set more than once when PARAM_ISMULTI is true? More... | |
| const | PARAM_DEPRECATED = 7 |
| (boolean) Is the parameter deprecated (will show a warning)? More... | |
| const | PARAM_REQUIRED = 8 |
| (boolean) Is the parameter required? More... | |
| const | PARAM_RANGE_ENFORCE = 9 |
| (boolean) For PARAM_TYPE 'integer', enforce PARAM_MIN and PARAM_MAX? More... | |
| const | PARAM_HELP_MSG = 10 |
| (string|array|Message) Specify an alternative i18n documentation message for this parameter. More... | |
| const | PARAM_HELP_MSG_APPEND = 11 |
| ((string|array|Message)[]) Specify additional i18n messages to append to the normal message for this parameter. More... | |
| const | PARAM_HELP_MSG_INFO = 12 |
| (array) Specify additional information tags for the parameter. More... | |
| 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. More... | |
| 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(). More... | |
| const | PARAM_SUBMODULE_MAP = 15 |
| (string[]) When PARAM_TYPE is 'submodule', map parameter values to submodule paths. More... | |
| 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). More... | |
Protected Member Functions | |
| getExamplesMessages () | |
| getIsWrappedHtml () | |
| Returns true when the special wrapped mode is enabled. More... | |
| getParameterFromSettings ($paramName, $paramSettings, $parseLimit) | |
| Overridden to honor $this->forceDefaultParams(), if applicable. More... | |
| Protected Member Functions inherited from ApiBase | |
| getExamplesMessages () | |
| Returns usage examples for this module. More... | |
| 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. More... | |
| getWebUITokenSalt (array $params) | |
| Fetch the salt used in the Web UI corresponding to this module. More... | |
| getDB () | |
| Gets a default replica DB connection object. More... | |
| getParameter ($paramName, $parseLimit=true) | |
| Get a value for the given parameter. More... | |
| getWatchlistValue ($watchlist, $titleObj, $userOption=null) | |
| Return true if we're to watch the page, false if not, null if no change. More... | |
| getParameterFromSettings ($paramName, $paramSettings, $parseLimit) | |
| Using the settings determine the value for the given parameter. More... | |
| handleParamNormalization ($paramName, $value, $rawValue) | |
| Handle when a parameter was Unicode-normalized. More... | |
| explodeMultiValue ($value, $limit) | |
| Split a multi-valued parameter string, like explode() More... | |
| 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. More... | |
| validateLimit ($paramName, &$value, $min, $max, $botMax=null, $enforceLimits=false) | |
| Validate the value against the minimum and user/bot maximum limits. More... | |
| validateTimestamp ($value, $encParamName) | |
| Validate and normalize of parameters of type 'timestamp'. More... | |
| setWatch ($watch, $titleObj, $userOption=null) | |
| Set a watch (or unwatch) based the based on a watchlist parameter. More... | |
| dieContinueUsageIf ($condition) | |
| Die with the $prefix. More... | |
| getDescriptionMessage () | |
| Return the description message. More... | |
| getHelpFlags () | |
| Generates the list of flags for the help screen and for action=paraminfo. More... | |
| getModuleSourceInfo () | |
| Returns information about the source of this module, if known. More... | |
| getDescription () | |
| Returns the description string for this module. More... | |
| getParamDescription () | |
| Returns an array of parameter descriptions. More... | |
| getExamples () | |
| Returns usage examples for this module. More... | |
| useTransactionalTimeLimit () | |
| Call wfTransactionalTimeLimit() if this request was POSTed. More... | |
Protected Attributes | |
| $mForceDefaultParams = false | |
Private Attributes | |
| $mBuffer | |
| $mIsHtml | |
| $mIsWrappedHtml = false | |
Additional Inherited Members | |
| Static Public Member Functions inherited from ApiBase | |
| static | truncateArray (&$arr, $limit) |
| Truncate an array to a certain length. More... | |
| static | makeMessage ($msg, IContextSource $context, array $params=null) |
| Create a Message from a string or array. More... | |
| Static Public Attributes inherited from ApiBase | |
| static | $messageMap |
| Array that maps message keys to error messages. More... | |
| Static Protected Member Functions inherited from ApiBase | |
| static | dieDebug ($method, $message) |
| Internal code errors should be reported with this method. More... | |
Detailed Description
This is the abstract base class for API formatters.
Definition at line 32 of file ApiFormatBase.php.
Constructor & Destructor Documentation
| ApiFormatBase::__construct | ( | ApiMain | $main, |
| $format | |||
| ) |
If $format ends with 'fm', pretty-print the output in HTML.
- Parameters
-
ApiMain $main string $format Format name
Definition at line 43 of file ApiFormatBase.php.
References ApiBase\getMain().
Member Function Documentation
| ApiFormatBase::canPrintErrors | ( | ) |
Whether this formatter can handle printing API errors.
If this returns false, then on API errors the default printer will be instantiated.
- Since
- 1.23
- Returns
- bool
Definition at line 118 of file ApiFormatBase.php.
| ApiFormatBase::closePrinter | ( | ) |
Finish printing and output buffered data.
Definition at line 181 of file ApiFormatBase.php.
References ContextSource\$context, $header, $mime, $out, $time, FormatJson\ALL_OK, Html\element(), FormatJson\encode(), ApiHelp\fixHelpLinks(), getBuffer(), ContextSource\getConfig(), SkinFactory\getDefaultInstance(), getFormat(), getIsHtml(), getIsWrappedHtml(), ApiBase\getMain(), getMimeType(), ApiBase\getResult(), SpecialPage\getTitleFor(), IContextSource\msg(), Html\rawElement(), and Hooks\run().
| ApiFormatBase::disable | ( | ) |
Disable the formatter.
This causes calls to initPrinter() and closePrinter() to be ignored.
Definition at line 98 of file ApiFormatBase.php.
| ApiFormatBase::forceDefaultParams | ( | ) |
Ignore request parameters, force a default.
Used as a fallback if errors are being thrown.
- Since
- 1.26
Definition at line 128 of file ApiFormatBase.php.
| ApiFormatBase::getAllowedParams | ( | ) |
Definition at line 281 of file ApiFormatBase.php.
References $ret, getIsHtml(), ApiBase\PARAM_DFLT, and ApiBase\PARAM_HELP_MSG.
| ApiFormatBase::getBuffer | ( | ) |
Get the contents of the buffer.
- Returns
- string
Definition at line 277 of file ApiFormatBase.php.
References $mBuffer.
Referenced by closePrinter().
|
protected |
Definition at line 293 of file ApiFormatBase.php.
References getFormat(), and ApiBase\getModuleName().
| ApiFormatBase::getFormat | ( | ) |
Get the internal format name.
- Returns
- string
Definition at line 70 of file ApiFormatBase.php.
References $mFormat.
Referenced by closePrinter(), and getExamplesMessages().
| ApiFormatBase::getHelpUrls | ( | ) |
Definition at line 300 of file ApiFormatBase.php.
| ApiFormatBase::getIsHtml | ( | ) |
Returns true when the HTML pretty-printer should be used.
The default implementation assumes that formats ending with 'fm' should be formatted in HTML.
- Returns
- bool
Definition at line 80 of file ApiFormatBase.php.
References $mIsHtml.
Referenced by closePrinter(), ApiFormatXml\execute(), ApiFormatJson\execute(), getAllowedParams(), and initPrinter().
|
protected |
Returns true when the special wrapped mode is enabled.
- Since
- 1.27
- Returns
- bool
Definition at line 89 of file ApiFormatBase.php.
References $mIsWrappedHtml.
Referenced by closePrinter(), and initPrinter().
|
abstract |
Overriding class returns the MIME type that should be sent to the client.
When getIsHtml() returns true, the return value here is used for syntax highlighting but the client sees text/html.
- Returns
- string
Referenced by closePrinter(), and initPrinter().
|
protected |
Overridden to honor $this->forceDefaultParams(), if applicable.
- Since
- 1.26
Definition at line 136 of file ApiFormatBase.php.
| ApiFormatBase::initPrinter | ( | $unused = false | ) |
Initialize the printer function and prepare the output headers.
- Parameters
-
bool $unused Always false since 1.25
Definition at line 154 of file ApiFormatBase.php.
References $mime, ContextSource\getConfig(), getIsHtml(), getIsWrappedHtml(), ApiBase\getMain(), and getMimeType().
Referenced by ApiMain\printResult().
| ApiFormatBase::isDisabled | ( | ) |
Whether the printer is disabled.
- Returns
- bool
Definition at line 106 of file ApiFormatBase.php.
References $mDisabled.
Referenced by ApiFormatFeedWrapper\initPrinter().
| ApiFormatBase::printText | ( | $text | ) |
Append text to the output buffer.
- Parameters
-
string $text
Definition at line 269 of file ApiFormatBase.php.
Referenced by ApiFormatXml\addXslt(), ApiFormatPhp\execute(), ApiFormatXml\execute(), ApiFormatJson\execute(), ApiFormatRaw\execute(), and ApiFormatFeedWrapper\execute().
Member Data Documentation
|
private |
Definition at line 34 of file ApiFormatBase.php.
Referenced by getBuffer().
| ApiFormatBase::$mDisabled = false |
Definition at line 34 of file ApiFormatBase.php.
Referenced by isDisabled().
|
protected |
Definition at line 36 of file ApiFormatBase.php.
| ApiFormatBase::$mFormat |
Definition at line 33 of file ApiFormatBase.php.
Referenced by getFormat().
| ApiFormatBase::$mHelp |
Definition at line 33 of file ApiFormatBase.php.
|
private |
Definition at line 33 of file ApiFormatBase.php.
Referenced by getIsHtml().
|
private |
Definition at line 35 of file ApiFormatBase.php.
Referenced by getIsWrappedHtml().
| ApiFormatBase::$mUnescapeAmps |
Definition at line 33 of file ApiFormatBase.php.
The documentation for this class was generated from the following file:
- includes/api/ApiFormatBase.php
