Public Member Functions | |
| __construct (RequestInterface $request, Authority $authority) | |
| 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
Definition at line 12 of file ParamValidatorCallbacks.php.
Constructor & Destructor Documentation
◆ __construct()
| MediaWiki\Rest\Validator\ParamValidatorCallbacks::__construct | ( | RequestInterface | $request, |
| Authority | $authority ) |
Definition at line 20 of file ParamValidatorCallbacks.php.
Member Function Documentation
◆ 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 69 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 54 of file ParamValidatorCallbacks.php.
◆ 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 49 of file ParamValidatorCallbacks.php.
◆ 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 62 of file ParamValidatorCallbacks.php.
References MediaWiki\Rest\Validator\ParamValidatorCallbacks\getUploadedFile().
◆ recordCondition()
| MediaWiki\Rest\Validator\ParamValidatorCallbacks::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 77 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 83 of file ParamValidatorCallbacks.php.
The documentation for this class was generated from the following file:
- includes/Rest/Validator/ParamValidatorCallbacks.php
