MediaWiki master
|
Type definition for "limit" types. More...
Inherits Wikimedia\ParamValidator\TypeDef\IntegerDef.
Public Member Functions | |||||||||||||||
checkSettings (string $name, $settings, array $options, array $ret) | |||||||||||||||
Validate a parameter settings array.This is intended for validation of parameter settings during unit or integration testing, and should implement strict checks.The rest of the code should generally be more permissive.
| |||||||||||||||
getHelpInfo ( $name, array $settings, array $options) | |||||||||||||||
Describe parameter settings in human-readable format.Keys in the returned array should generally correspond to PARAM constants.If relevant, a MessageValue describing the type itself should be returned with key ParamValidator::PARAM_TYPE.The default messages for other ParamValidator-defined PARAM constants may be suppressed by returning null as the value for those constants, or replaced by returning a replacement MessageValue. Normally, however, the default messages should not be changed.MessageValues describing any other constraints applied via PARAM constants specific to this class should also be returned.
| |||||||||||||||
normalizeSettings (array $settings) | |||||||||||||||
Normalize a settings array.
| |||||||||||||||
validate ( $name, $value, array $settings, array $options) | |||||||||||||||
Validate the value.When ParamValidator is processing a multi-valued parameter, this will be called once for each of the supplied values. Which may mean zero calls.When getValue() returned null, this will not be called.
| |||||||||||||||
![]() | |||||||||||||||
stringifyValue ( $name, $value, array $settings, array $options) | |||||||||||||||
Convert a value to a string representation. | |||||||||||||||
![]() | |||||||||||||||
getParamInfo ( $name, array $settings, array $options) | |||||||||||||||
Describe parameter settings in a machine-readable format.Keys should be short strings using lowercase ASCII letters. Values should generally be values that could be encoded in JSON or the like.This is intended to handle PARAM constants specific to this class. It generally shouldn't handle constants defined on ParamValidator itself.
| |||||||||||||||
![]() | |||||||||||||||
__construct (Callbacks $callbacks) | |||||||||||||||
getEnumValues ( $name, array $settings, array $options) | |||||||||||||||
Get the values for enum-like parameters. | |||||||||||||||
getValue ( $name, array $settings, array $options) | |||||||||||||||
Get the value from the request. | |||||||||||||||
supportsArrays () | |||||||||||||||
Whether the value may be an array. | |||||||||||||||
Additional Inherited Members | |
![]() | |
const | PARAM_IGNORE_RANGE = 'param-ignore-range' |
(bool) Whether to enforce the specified range. | |
const | PARAM_MAX = 'param-max' |
(int|float) Maximum allowed value (normal limits) | |
const | PARAM_MAX2 = 'param-max2' |
(int|float) Maximum allowed value (high limits) | |
const | PARAM_MIN = 'param-min' |
(int|float) Minimum allowed value. | |
![]() | |
const | OPT_ENFORCE_JSON_TYPES = 'enforce-json-types' |
Option that instructs TypeDefs to enforce the native type of parameter values, instead of allowing string values as input. | |
const | OPT_LOG_BAD_TYPES = 'log-bad-types' |
![]() | |
checkRange ( $value, $name, $origValue, array $settings, array $options) | |
Check the range of a value. | |
![]() | |
failIfNotString (string $name, $value, array $settings, array $options) | |
Fails if $value is not a string. | |
failure ( $failure, $name, $value, array $settings, array $options, $fatal=true) | |
Record a failure message. | |
failureMessage ( $code, ?array $data=null, $suffix=null) | |
Create a DataMessageValue representing a failure. | |
fatal ( $failure, $name, $value, array $settings, array $options) | |
Throw a ValidationException. | |
![]() | |
string | $valueType = 'integer' |
PHP type (as from gettype() ) of values this NumericDef handles. | |
![]() | |
Callbacks | $callbacks |
Type definition for "limit" types.
A limit type is an integer type that also accepts the magic value "max". IntegerDef::PARAM_MIN defaults to 0 for this type.
Definition at line 18 of file LimitDef.php.
Wikimedia\ParamValidator\TypeDef\LimitDef::checkSettings | ( | string | $name, |
$settings, | |||
array | $options, | ||
array | $ret ) |
Validate a parameter settings array.This is intended for validation of parameter settings during unit or integration testing, and should implement strict checks.The rest of the code should generally be more permissive.
string | $name | Parameter name |
array | mixed | $settings | Default value or an array of settings using PARAM_* constants. |
array | $options | Options array, passed through to the TypeDef and Callbacks. |
array | $ret |
|
Reimplemented from Wikimedia\ParamValidator\TypeDef\NumericDef.
Definition at line 51 of file LimitDef.php.
References Wikimedia\ParamValidator\ParamValidator\PARAM_ISMULTI.
Wikimedia\ParamValidator\TypeDef\LimitDef::getHelpInfo | ( | $name, | |
array | $settings, | ||
array | $options ) |
Describe parameter settings in human-readable format.Keys in the returned array should generally correspond to PARAM constants.If relevant, a MessageValue describing the type itself should be returned with key ParamValidator::PARAM_TYPE.The default messages for other ParamValidator-defined PARAM constants may be suppressed by returning null as the value for those constants, or replaced by returning a replacement MessageValue. Normally, however, the default messages should not be changed.MessageValues describing any other constraints applied via PARAM constants specific to this class should also be returned.
string | $name | Parameter name being described. |
array | $settings | Parameter settings array. |
array | $options | Options array. |
Reimplemented from Wikimedia\ParamValidator\TypeDef\IntegerDef.
Definition at line 71 of file LimitDef.php.
References Wikimedia\ParamValidator\ParamValidator\PARAM_TYPE.
Wikimedia\ParamValidator\TypeDef\LimitDef::normalizeSettings | ( | array | $settings | ) |
Normalize a settings array.
array | $settings |
Reimplemented from Wikimedia\ParamValidator\TypeDef\NumericDef.
Definition at line 40 of file LimitDef.php.
References Wikimedia\ParamValidator\ParamValidator\PARAM_ISMULTI.
Wikimedia\ParamValidator\TypeDef\LimitDef::validate | ( | $name, | |
$value, | |||
array | $settings, | ||
array | $options ) |
Validate the value.When ParamValidator is processing a multi-valued parameter, this will be called once for each of the supplied values. Which may mean zero calls.When getValue() returned null, this will not be called.
string | $name | Parameter name being validated. |
mixed | $value | Value to validate, from getValue(). |
array | $settings | Parameter settings array. |
array | $options | Options array. Note the following values that may be set by ParamValidator:
|
ValidationException | if the value is invalid |
Additional $options
accepted:
Reimplemented from Wikimedia\ParamValidator\TypeDef\IntegerDef.
Definition at line 27 of file LimitDef.php.
References Wikimedia\ParamValidator\TypeDef\NumericDef\PARAM_MAX, and Wikimedia\ParamValidator\TypeDef\NumericDef\PARAM_MAX2.