MediaWiki REL1_39
|
ParamValidator callbacks for the Action API. More...
Public Member Functions | |
__construct (ApiMain $main) | |
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. | |
ParamValidator callbacks for the Action API.
Definition at line 16 of file ApiParamValidatorCallbacks.php.
MediaWiki\Api\Validator\ApiParamValidatorCallbacks::__construct | ( | ApiMain | $main | ) |
ApiMain | $main |
Definition at line 28 of file ApiParamValidatorCallbacks.php.
MediaWiki\Api\Validator\ApiParamValidatorCallbacks::getUploadedFile | ( | $name, | |
array | $options ) |
Fetch data for a file upload.
string | $name | Parameter name of the upload |
array | $options | Options array |
Implements Wikimedia\ParamValidator\Callbacks.
Definition at line 67 of file ApiParamValidatorCallbacks.php.
Referenced by MediaWiki\Api\Validator\ApiParamValidatorCallbacks\hasUpload().
MediaWiki\Api\Validator\ApiParamValidatorCallbacks::getValue | ( | $name, | |
$default, | |||
array | $options ) |
Fetch a value from the request.
Return $default
for file-upload parameters.
string | $name | Parameter name to fetch |
mixed | $default | Default value to return if the parameter is unset. |
array | $options | Options array |
Implements Wikimedia\ParamValidator\Callbacks.
Definition at line 37 of file ApiParamValidatorCallbacks.php.
MediaWiki\Api\Validator\ApiParamValidatorCallbacks::hasParam | ( | $name, | |
array | $options ) |
Test if a parameter exists in the request.
string | $name | Parameter name |
array | $options | Options array |
Implements Wikimedia\ParamValidator\Callbacks.
Definition at line 33 of file ApiParamValidatorCallbacks.php.
MediaWiki\Api\Validator\ApiParamValidatorCallbacks::hasUpload | ( | $name, | |
array | $options ) |
Test if a parameter exists as an upload in the request.
string | $name | Parameter name |
array | $options | Options array |
Implements Wikimedia\ParamValidator\Callbacks.
Definition at line 63 of file ApiParamValidatorCallbacks.php.
References MediaWiki\Api\Validator\ApiParamValidatorCallbacks\getUploadedFile().
MediaWiki\Api\Validator\ApiParamValidatorCallbacks::recordCondition | ( | DataMessageValue | $message, |
$name, | |||
$value, | |||
array | $settings, | ||
array | $options ) |
Record non-fatal conditions.
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 81 of file ApiParamValidatorCallbacks.php.
References Wikimedia\Message\DataMessageValue\getCode(), Wikimedia\Message\DataMessageValue\getData(), Wikimedia\Message\MessageValue\getKey(), and Wikimedia\Message\MessageValue\getParams().
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.
array | $options | Options array |
Implements Wikimedia\ParamValidator\Callbacks.
Definition at line 137 of file ApiParamValidatorCallbacks.php.