ApiFormatRaw Class Reference

Formatter that spits out anything you like with any desired MIME type. More...

Inheritance diagram for ApiFormatRaw:

Collaboration diagram for ApiFormatRaw:

Public Member Functions
	__construct (ApiMain $main, ApiFormatBase $errorFallback=null)
	closePrinter ()
	Finish printing and output buffered data.
	execute ()
	Evaluates the parameters, performs the requested query, and sets up the result.
	getFilename ()
	Return a filename for this module's output.
	getMimeType ()
	Overriding class returns the MIME type that should be sent to the client.
	initPrinter ( $unused=false)
	Initialize the printer function and prepare the output headers.
	setFailWithHTTPError ( $fail)
	Output HTTP error code 400 when if an error is encountered.
Public Member Functions inherited from ApiFormatBase
	__construct (ApiMain $main, $format)
	If $format ends with 'fm', pretty-print the output in HTML.
	canPrintErrors ()
	Whether this formatter can handle printing API errors.
	disable ()
	Disable the formatter.
	forceDefaultParams ()
	Ignore request parameters, force a default.
	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.
	getBuffer ()
	Get the contents of the buffer.
	getFormat ()
	Get the internal format name.
	getHelpUrls ()
	Return links to more detailed help pages about the module.
	getIsHtml ()
	Returns true when the HTML pretty-printer should be used.
	isDisabled ()
	Whether the printer is disabled.
	printText ( $text)
	Append text to the output buffer.
	setHttpStatus ( $code)
	Set the HTTP status code to be used for the response.
Public Member Functions inherited from ApiBase
	__construct (ApiMain $mainModule, $moduleName, $modulePrefix='')
	getModuleManager ()
	Get the module manager, or null if this module has no sub-modules.
	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.
	shouldCheckMaxlag ()
	Indicates if this module needs maxlag to be checked.
	isReadMode ()
	Indicates whether this module requires read rights.
	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 (ApiContinuationManager $manager=null)
	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 ( $options=[])
	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.
	getTitleFromTitleOrPageId ( $params)
	Get a Title 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.
	errorArrayToStatus (array $errors, User $user=null)
	Turn an array of message keys or key+param arrays into a Status.
	addBlockInfoToStatus (StatusValue $status, User $user=null)
	Add block info to block messages in a Status.
	addWarning ( $msg, $code=null, $data=null)
	Add a warning for this module.
	addDeprecation ( $msg, $feature, $data=[])
	Add a deprecation warning for this module.
	addError ( $msg, $code=null, $data=null)
	Add an error for this module without aborting.
	addMessagesFromStatus (StatusValue $status, $types=[ 'warning', 'error'], array $filter=[])
	Add warnings and/or errors from a Status.
	dieWithError ( $msg, $code=null, $data=null, $httpCode=null)
	Abort execution with an error.
	dieWithException ( $exception, array $options=[])
	Abort execution with an error derived from an exception.
	dieBlocked (AbstractBlock $block)
	Throw an ApiUsageException, which will (if uncaught) call the main module's error handler and die with an error message including block info.
	dieStatus (StatusValue $status)
	Throw an ApiUsageException based on the Status object.
	dieReadOnly ()
	Helper function for readonly errors.
	checkUserRightsAny ( $rights, $user=null)
	Helper function for permission-denied errors.
	checkTitleUserPermissions (LinkTarget $linkTarget, $actions, $options=[])
	Helper function for permission-denied errors.
	dieWithErrorOrDebug ( $msg, $code=null, $data=null, $httpCode=null)
	Will only set a warning instead of failing if the global $wgDebugAPI is set to true.
	logFeatureUsage ( $feature)
	Write logging information for API features to a debug log, for usage analysis.
	getFinalSummary ()
	Get final module summary.
	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.
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 ()
	getContext ()
	Get the base IContextSource object.
	getLanguage ()
	getOutput ()
	getRequest ()
	getSkin ()
	getStats ()
	getTiming ()
	getTitle ()
	getUser ()
	getWikiPage ()
	Get the WikiPage object.
	msg ( $key,... $params)
	Get a Message object with context set Parameters are the same as wfMessage()
	setContext (IContextSource $context)

Private Attributes
	$errorFallback
	$mFailWithHTTPError = false

Additional Inherited Members
Static Public Member Functions inherited from ApiBase
static	makeMessage ( $msg, IContextSource $context, array $params=null)
	Create a Message from a string or array.
Public Attributes inherited from ApiBase
const	ALL_DEFAULT_STRING = '*'
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_ALL = 17
	(boolean|string) When PARAM_TYPE has a defined set of values and PARAM_ISMULTI is true, this allows for an asterisk ('*') to be passed in place of a pipe-separated list of every possible value.
const	PARAM_EXTRA_NAMESPACES = 18
	(int[]) When PARAM_TYPE is 'namespace', include these as additional possible values.
const	PARAM_SENSITIVE = 19
	(boolean) Is the parameter sensitive? Note 'password'-type fields are always sensitive regardless of the value of this field.
const	PARAM_DEPRECATED_VALUES = 20
	(array) When PARAM_TYPE is an array, this indicates which of the values are deprecated.
const	PARAM_ISMULTI_LIMIT1 = 21
	(integer) Maximum number of values, for normal users.
const	PARAM_ISMULTI_LIMIT2 = 22
	(integer) Maximum number of values, for users with the apihighimits right.
const	PARAM_MAX_BYTES = 23
	(integer) Maximum length of a string in bytes (in UTF-8 encoding).
const	PARAM_MAX_CHARS = 24
	(integer) Maximum length of a string in characters (unicode codepoints).
const	PARAM_TEMPLATE_VARS = 25
	(array) Indicate that this is a templated parameter, and specify replacements.
Protected Member Functions inherited from ApiFormatBase
	getExamplesMessages ()
	Returns usage examples for this module.
	getIsWrappedHtml ()
	Returns true when the special wrapped mode is enabled.
	getParameterFromSettings ( $paramName, $paramSettings, $parseLimit)
	Overridden to honor $this->forceDefaultParams(), if applicable Using the settings determine the value for the given parameter. Parameters string $paramName Parameter name array | mixed $paramSettings Default value or an array of settings using PARAM_* constants. bool $parseLimit Whether to parse and validate 'limit' parameters Returns mixed Parameter value .
Protected Member Functions inherited from ApiBase
	getWebUITokenSalt (array $params)
	Fetch the salt used in the Web UI corresponding to this module.
	getDB ()
	Gets a default replica DB connection object.
	getPermissionManager ()
	Obtain a PermissionManager instance that subclasses may use in their authorization checks.
	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.
	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, $allSpecifier=null, $limit1=null, $limit2=null)
	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 parameters of type 'timestamp'.
	setWatch ( $watch, $titleObj, $userOption=null)
	Set a watch (or unwatch) based the based on a watchlist parameter.
	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed.
	filterIDs ( $fields, array $ids)
	Filter out-of-range values from a list of positive integer IDs.
	dieContinueUsageIf ( $condition)
	Die with the 'badcontinue' error.
	getSummaryMessage ()
	Return the summary message.
	getExtendedDescription ()
	Return the extended help text 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.
Static Protected Member Functions inherited from ApiBase
static	dieDebug ( $method, $message)
	Internal code errors should be reported with this method.
Protected Attributes inherited from ApiFormatBase
	$mForceDefaultParams = false

Detailed Description

Formatter that spits out anything you like with any desired MIME type.

Definition at line 27 of file ApiFormatRaw.php.

Constructor & Destructor Documentation

__construct()

ApiFormatRaw::__construct	(	ApiMain	$main,
		ApiFormatBase	$errorFallback = null )

Parameters

ApiMain	$main
ApiFormatBase | null	$errorFallback	Object to fall back on for errors

Definition at line 36 of file ApiFormatRaw.php.

References $errorFallback, ApiMain\createPrinterByName(), and ApiBase\getParameter().

Member Function Documentation

closePrinter()

ApiFormatRaw::closePrinter

(

)

Finish printing and output buffered data.

Reimplemented from ApiFormatBase.

Definition at line 79 of file ApiFormatRaw.php.

References ApiBase\getResult().

execute()

ApiFormatRaw::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 88 of file ApiFormatRaw.php.

References ApiBase\dieDebug(), ApiBase\getResult(), and ApiFormatBase\printText().

getFilename()

ApiFormatRaw::getFilename

(

)

Return a filename for this module's output.

Note

If $this->getIsWrappedHtml() || $this->getIsHtml(), you'll very likely want to fall back to this class's version.

Since

1.27

Returns

string Generally this should be "api-result.$ext"

Reimplemented from ApiFormatBase.

Definition at line 56 of file ApiFormatRaw.php.

References ApiFormatBase\getIsHtml(), ApiFormatBase\getIsWrappedHtml(), and ApiBase\getResult().

getMimeType()

ApiFormatRaw::getMimeType

(

)

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

Reimplemented from ApiFormatBase.

Definition at line 42 of file ApiFormatRaw.php.

References ApiBase\dieDebug(), and ApiBase\getResult().

initPrinter()

ApiFormatRaw::initPrinter

(

$unused = false

)

Initialize the printer function and prepare the output headers.

Parameters

bool

$unused

Always false since 1.25

Reimplemented from ApiFormatBase.

Definition at line 67 of file ApiFormatRaw.php.

References ApiBase\getMain(), and ApiBase\getResult().

setFailWithHTTPError()

ApiFormatRaw::setFailWithHTTPError

(

$fail

)

Output HTTP error code 400 when if an error is encountered.

The purpose is for output formats where the user-agent will not be able to interpret the validity of the content in any other way. For example subtitle files read by browser video players.

Parameters

bool

$fail

Definition at line 110 of file ApiFormatRaw.php.

Member Data Documentation

$errorFallback

ApiFormatRaw::$errorFallback

private

Definition at line 29 of file ApiFormatRaw.php.

Referenced by __construct().

$mFailWithHTTPError

ApiFormatRaw::$mFailWithHTTPError = false

private

Definition at line 30 of file ApiFormatRaw.php.

---

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

• includes/api/ApiFormatRaw.php