Wikimedia\ParamValidator\Callbacks Interface Reference

Interface defining callbacks needed by ParamValidator. More...

Inherited by MediaWiki\Api\Validator\ApiParamValidatorCallbacks, MediaWiki\Rest\Validator\ParamValidatorCallbacks, and Wikimedia\ParamValidator\SimpleCallbacks.

Public Member Functions
	getUploadedFile ( $name, array $options)
	Fetch data for a file upload.
	getValue ( $name, $default, array $options)
	Fetch a value from the request.
	hasParam ( $name, array $options)
	Test if a parameter exists in the request.
	hasUpload ( $name, array $options)
	Test if a parameter exists as an upload in the request.
	recordCondition (DataMessageValue $message, $name, $value, array $settings, array $options)
	Record non-fatal conditions.
	useHighLimits (array $options)
	Indicate whether "high limits" should be used.

Detailed Description

Interface defining callbacks needed by ParamValidator.

The user of ParamValidator is expected to pass an object implementing this interface to ParamValidator's constructor.

All methods in this interface accept an "options array". This is the same $options passed to ParamValidator::getValue(), ParamValidator::validateValue(), and the like and is intended for communication of non-global state.

Since

1.34

Stability: unstable

Definition at line 21 of file Callbacks.php.

Member Function Documentation

getUploadedFile()

Wikimedia\ParamValidator\Callbacks::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.

Implemented in MediaWiki\Api\Validator\ApiParamValidatorCallbacks, Wikimedia\ParamValidator\SimpleCallbacks, and MediaWiki\Rest\Validator\ParamValidatorCallbacks.

getValue()

Wikimedia\ParamValidator\Callbacks::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.

Implemented in MediaWiki\Api\Validator\ApiParamValidatorCallbacks, Wikimedia\ParamValidator\SimpleCallbacks, and MediaWiki\Rest\Validator\ParamValidatorCallbacks.

hasParam()

Wikimedia\ParamValidator\Callbacks::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.

Implemented in MediaWiki\Api\Validator\ApiParamValidatorCallbacks, Wikimedia\ParamValidator\SimpleCallbacks, and MediaWiki\Rest\Validator\ParamValidatorCallbacks.

hasUpload()

Wikimedia\ParamValidator\Callbacks::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.

Implemented in MediaWiki\Api\Validator\ApiParamValidatorCallbacks, Wikimedia\ParamValidator\SimpleCallbacks, and MediaWiki\Rest\Validator\ParamValidatorCallbacks.

recordCondition()

Wikimedia\ParamValidator\Callbacks::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

Implemented in MediaWiki\Api\Validator\ApiParamValidatorCallbacks, Wikimedia\ParamValidator\SimpleCallbacks, and MediaWiki\Rest\Validator\ParamValidatorCallbacks.

useHighLimits()

Wikimedia\ParamValidator\Callbacks::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

Implemented in MediaWiki\Api\Validator\ApiParamValidatorCallbacks, Wikimedia\ParamValidator\SimpleCallbacks, and MediaWiki\Rest\Validator\ParamValidatorCallbacks.

---

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

• includes/libs/ParamValidator/Callbacks.php