MediaWiki\Api\Validator\ApiParamValidatorCallbacks Class Reference

ParamValidator callbacks for the Action API. More...

Inherits Wikimedia\ParamValidator\Callbacks.

Collaboration diagram for MediaWiki\Api\Validator\ApiParamValidatorCallbacks:

Public Member Functions
	__construct (ApiMain $main)
	getUploadedFile ( $name, array $options)
	Fetch data for a file upload. Parameters string $name Parameter name of the upload array $options Options array Returns UploadedFileInterface|null Uploaded file, or null if there is no file for $name.
	getValue ( $name, $default, array $options)
	Fetch a value from the request.Return $default for file-upload parameters. Parameters string $name Parameter name to fetch mixed $default Default value to return if the parameter is unset. array $options Options array Returns string|string[]|mixed A string or string[] if the parameter was found, or $default if it was not.
	hasParam ( $name, array $options)
	Test if a parameter exists in the request. Parameters string $name Parameter name array $options Options array Returns bool True if present, false if absent. Return false for file upload parameters.
	hasUpload ( $name, array $options)
	Test if a parameter exists as an upload in the request. Parameters string $name Parameter name array $options Options array Returns bool True if present, false if absent.
	recordCondition (DataMessageValue $message, $name, $value, array $settings, array $options)
	Record non-fatal conditions. Parameters DataMessageValue $message Failure message string $name Parameter name mixed $value Parameter value array $settings Parameter settings array array $options Options array
	useHighLimits (array $options)
	Indicate whether "high limits" should be used.Some settings have multiple limits, one for "normal" users and a higher one for "privileged" users. This is used to determine which class the current user is in when necessary. Parameters array $options Options array Returns bool Whether the current user is privileged to use high limits

Detailed Description

ParamValidator callbacks for the Action API.

Since

1.35

Definition at line 16 of file ApiParamValidatorCallbacks.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Api\Validator\ApiParamValidatorCallbacks::__construct

(

ApiMain

$main

)

Access: internal

Parameters

ApiMain

$main

Definition at line 25 of file ApiParamValidatorCallbacks.php.

Member Function Documentation

getUploadedFile()

MediaWiki\Api\Validator\ApiParamValidatorCallbacks::getUploadedFile	(		$name,
		array	$options )

Fetch data for a file upload.

Parameters

string	$name	Parameter name of the upload
array	$options	Options array

Returns

UploadedFileInterface|null Uploaded file, or null if there is no file for $name.

Implements Wikimedia\ParamValidator\Callbacks.

Definition at line 67 of file ApiParamValidatorCallbacks.php.

Referenced by MediaWiki\Api\Validator\ApiParamValidatorCallbacks\hasUpload().

getValue()

MediaWiki\Api\Validator\ApiParamValidatorCallbacks::getValue	(		$name,
			$default,
		array	$options )

Fetch a value from the request.Return $default for file-upload parameters.

Parameters

string	$name	Parameter name to fetch
mixed	$default	Default value to return if the parameter is unset.
array	$options	Options array

Returns

string|string[]|mixed A string or string[] if the parameter was found, or $default if it was not.

Implements Wikimedia\ParamValidator\Callbacks.

Definition at line 35 of file ApiParamValidatorCallbacks.php.

hasParam()

MediaWiki\Api\Validator\ApiParamValidatorCallbacks::hasParam	(		$name,
		array	$options )

Test if a parameter exists in the request.

Parameters

string	$name	Parameter name
array	$options	Options array

Returns

bool True if present, false if absent. Return false for file upload parameters.

Implements Wikimedia\ParamValidator\Callbacks.

Definition at line 30 of file ApiParamValidatorCallbacks.php.

hasUpload()

MediaWiki\Api\Validator\ApiParamValidatorCallbacks::hasUpload	(		$name,
		array	$options )

Test if a parameter exists as an upload in the request.

Parameters

string	$name	Parameter name
array	$options	Options array

Returns

bool True if present, false if absent.

Implements Wikimedia\ParamValidator\Callbacks.

Definition at line 62 of file ApiParamValidatorCallbacks.php.

References MediaWiki\Api\Validator\ApiParamValidatorCallbacks\getUploadedFile().

recordCondition()

MediaWiki\Api\Validator\ApiParamValidatorCallbacks::recordCondition	(	DataMessageValue	$message,
			$name,
			$value,
		array	$settings,
		array	$options )

Record non-fatal conditions.

Parameters

DataMessageValue	$message	Failure message
string	$name	Parameter name
mixed	$value	Parameter value
array	$settings	Parameter settings array
array	$options	Options array

Implements Wikimedia\ParamValidator\Callbacks.

Definition at line 82 of file ApiParamValidatorCallbacks.php.

References Wikimedia\Message\DataMessageValue\getCode(), Wikimedia\Message\DataMessageValue\getData(), Wikimedia\Message\MessageValue\getKey(), and Wikimedia\Message\MessageValue\getParams().

useHighLimits()

MediaWiki\Api\Validator\ApiParamValidatorCallbacks::useHighLimits

(

array

$options

)

Indicate whether "high limits" should be used.Some settings have multiple limits, one for "normal" users and a higher one for "privileged" users. This is used to determine which class the current user is in when necessary.

Parameters

array

$options

Options array

Returns

bool Whether the current user is privileged to use high limits

Implements Wikimedia\ParamValidator\Callbacks.

Definition at line 139 of file ApiParamValidatorCallbacks.php.

---

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

• includes/Api/Validator/ApiParamValidatorCallbacks.php