Simple Callbacks implementation for $_GET/$_POST/$_FILES data. More...
Public Member Functions | |
| __construct (array $params, array $files=[]) | |
| clearRecordedConditions () | |
| Clear any recorded conditions. More... | |
| getRecordedConditions () | |
| Fetch any recorded conditions. More... | |
| 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 Attributes | |
| array | $conditions = [] |
| Any recorded conditions. More... | |
| array UploadedFile[] | $files |
| $_FILES data or UploadedFile instances More... | |
| string string[][] | $params |
| $_GET/$_POST data More... | |
Detailed Description
Simple Callbacks implementation for $_GET/$_POST/$_FILES data.
Options array keys used by this class:
- 'useHighLimits': (bool) Return value from useHighLimits()
- Since
- 1.34 @unstable
Definition at line 16 of file SimpleCallbacks.php.
Constructor & Destructor Documentation
◆ __construct()
| Wikimedia\ParamValidator\SimpleCallbacks::__construct | ( | array | $params, |
| array | $files = [] |
||
| ) |
- Parameters
-
(string|string[])[] $params Data from $_POST + $_GET array[] $files Data from $_FILES
Definition at line 31 of file SimpleCallbacks.php.
References Wikimedia\ParamValidator\SimpleCallbacks\$files, and Wikimedia\ParamValidator\SimpleCallbacks\$params.
Member Function Documentation
◆ clearRecordedConditions()
| Wikimedia\ParamValidator\SimpleCallbacks::clearRecordedConditions | ( | ) |
Clear any recorded conditions.
Definition at line 72 of file SimpleCallbacks.php.
◆ getRecordedConditions()
| Wikimedia\ParamValidator\SimpleCallbacks::getRecordedConditions | ( | ) |
Fetch any recorded conditions.
- Returns
- array[]
Definition at line 65 of file SimpleCallbacks.php.
References Wikimedia\ParamValidator\SimpleCallbacks\$conditions.
◆ getUploadedFile()
| Wikimedia\ParamValidator\SimpleCallbacks::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 48 of file SimpleCallbacks.php.
References $file.
◆ getValue()
| Wikimedia\ParamValidator\SimpleCallbacks::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 40 of file SimpleCallbacks.php.
◆ hasParam()
| Wikimedia\ParamValidator\SimpleCallbacks::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 36 of file SimpleCallbacks.php.
◆ hasUpload()
| Wikimedia\ParamValidator\SimpleCallbacks::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 44 of file SimpleCallbacks.php.
◆ recordCondition()
| Wikimedia\ParamValidator\SimpleCallbacks::recordCondition | ( | ValidationException | $condition, |
| array | $options | ||
| ) |
Record non-fatal conditions.
- Parameters
-
ValidationException $condition array $options Options array
Implements Wikimedia\ParamValidator\Callbacks.
Definition at line 57 of file SimpleCallbacks.php.
◆ useHighLimits()
| Wikimedia\ParamValidator\SimpleCallbacks::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 76 of file SimpleCallbacks.php.
Member Data Documentation
◆ $conditions
|
private |
Any recorded conditions.
Definition at line 25 of file SimpleCallbacks.php.
Referenced by Wikimedia\ParamValidator\SimpleCallbacks\getRecordedConditions().
◆ $files
|
private |
$_FILES data or UploadedFile instances
Definition at line 22 of file SimpleCallbacks.php.
Referenced by Wikimedia\ParamValidator\SimpleCallbacks\__construct().
◆ $params
|
private |
$_GET/$_POST data
Definition at line 19 of file SimpleCallbacks.php.
Referenced by Wikimedia\ParamValidator\SimpleCallbacks\__construct().
The documentation for this class was generated from the following file:
- includes/libs/ParamValidator/SimpleCallbacks.php
