MediaWiki\Rest\Validator\ParamValidatorCallbacks Class Reference

Inheritance diagram for MediaWiki\Rest\Validator\ParamValidatorCallbacks:

Collaboration diagram for MediaWiki\Rest\Validator\ParamValidatorCallbacks:

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

Private Member Functions
	getParamsFromSource ( $source)
	Get the raw parameters from a source in the request. More...

Private Attributes
PermissionManager	$permissionManager
RequestInterface	$request
UserIdentity	$user

Detailed Description

Definition at line 13 of file ParamValidatorCallbacks.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Rest\Validator\ParamValidatorCallbacks::__construct	(	PermissionManager	$permissionManager,
		RequestInterface	$request,
		UserIdentity	$user
	)

Definition at line 24 of file ParamValidatorCallbacks.php.

References MediaWiki\Rest\Validator\ParamValidatorCallbacks\$permissionManager, MediaWiki\Rest\Validator\ParamValidatorCallbacks\$request, and MediaWiki\Rest\Validator\ParamValidatorCallbacks\$user.

Member Function Documentation

getParamsFromSource()

MediaWiki\Rest\Validator\ParamValidatorCallbacks::getParamsFromSource (   $source )

private

Get the raw parameters from a source in the request.

Parameters

string

$source

'path', 'query', or 'post'

Returns

array

Definition at line 39 of file ParamValidatorCallbacks.php.

References $source.

Referenced by MediaWiki\Rest\Validator\ParamValidatorCallbacks\getValue(), and MediaWiki\Rest\Validator\ParamValidatorCallbacks\hasParam().

getUploadedFile()

MediaWiki\Rest\Validator\ParamValidatorCallbacks::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 75 of file ParamValidatorCallbacks.php.

Referenced by MediaWiki\Rest\Validator\ParamValidatorCallbacks\hasUpload().

getValue()

MediaWiki\Rest\Validator\ParamValidatorCallbacks::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 60 of file ParamValidatorCallbacks.php.

References MediaWiki\Rest\Validator\ParamValidatorCallbacks\getParamsFromSource().

hasParam()

MediaWiki\Rest\Validator\ParamValidatorCallbacks::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 55 of file ParamValidatorCallbacks.php.

References MediaWiki\Rest\Validator\ParamValidatorCallbacks\getParamsFromSource().

hasUpload()

MediaWiki\Rest\Validator\ParamValidatorCallbacks::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 68 of file ParamValidatorCallbacks.php.

References MediaWiki\Rest\Validator\ParamValidatorCallbacks\getUploadedFile().

recordCondition()

MediaWiki\Rest\Validator\ParamValidatorCallbacks::recordCondition	(	ValidationException	$condition,
		array	$options
	)

Record non-fatal conditions.

Parameters

ValidationException	$condition
array	$options	Options array

Implements Wikimedia\ParamValidator\Callbacks.

Definition at line 83 of file ParamValidatorCallbacks.php.

useHighLimits()

MediaWiki\Rest\Validator\ParamValidatorCallbacks::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 87 of file ParamValidatorCallbacks.php.

Member Data Documentation

$permissionManager

PermissionManager MediaWiki\Rest\Validator\ParamValidatorCallbacks::$permissionManager

private

Definition at line 16 of file ParamValidatorCallbacks.php.

Referenced by MediaWiki\Rest\Validator\ParamValidatorCallbacks\__construct().

$request

RequestInterface MediaWiki\Rest\Validator\ParamValidatorCallbacks::$request

private

Definition at line 19 of file ParamValidatorCallbacks.php.

Referenced by MediaWiki\Rest\Validator\ParamValidatorCallbacks\__construct().

$user

UserIdentity MediaWiki\Rest\Validator\ParamValidatorCallbacks::$user

private

Definition at line 22 of file ParamValidatorCallbacks.php.

Referenced by MediaWiki\Rest\Validator\ParamValidatorCallbacks\__construct().

---

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

• includes/Rest/Validator/ParamValidatorCallbacks.php