MediaWiki REL1_39
|
Type definition for integer types. More...
Public Member Functions | |||||||||||||
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.
| |||||||||||||
stringifyValue ( $name, $value, array $settings, array $options) | |||||||||||||
Convert a value to a string representation. | |||||||||||||
validate ( $name, $value, array $settings, array $options) | |||||||||||||
Validate the value. | |||||||||||||
Public Member Functions inherited from Wikimedia\ParamValidator\TypeDef\NumericDef | |||||||||||||
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.
| |||||||||||||
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.
| |||||||||||||
normalizeSettings (array $settings) | |||||||||||||
Normalize a settings array.
| |||||||||||||
Public Member Functions inherited from Wikimedia\ParamValidator\TypeDef | |||||||||||||
__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. | |||||||||||||
Additional Inherited Members | |
Public Attributes inherited from Wikimedia\ParamValidator\TypeDef\NumericDef | |
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. | |
Protected Member Functions inherited from Wikimedia\ParamValidator\TypeDef\NumericDef | |
checkRange ( $value, $name, $origValue, array $settings, array $options) | |
Check the range of a value. | |
Protected Member Functions inherited from Wikimedia\ParamValidator\TypeDef | |
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. | |
Protected Attributes inherited from Wikimedia\ParamValidator\TypeDef\NumericDef | |
string | $valueType = 'integer' |
PHP type (as from gettype() ) of values this NumericDef handles. | |
Protected Attributes inherited from Wikimedia\ParamValidator\TypeDef | |
Callbacks | $callbacks |
Type definition for integer types.
A valid representation consists of an optional sign (+
or -
) followed by one or more decimal digits.
The result from validate() is a PHP integer.
Definition at line 23 of file IntegerDef.php.
Wikimedia\ParamValidator\TypeDef\IntegerDef::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\NumericDef.
Reimplemented in Wikimedia\ParamValidator\TypeDef\LimitDef.
Definition at line 42 of file IntegerDef.php.
References Wikimedia\ParamValidator\ParamValidator\PARAM_ISMULTI, and Wikimedia\ParamValidator\ParamValidator\PARAM_TYPE.
Wikimedia\ParamValidator\TypeDef\IntegerDef::stringifyValue | ( | $name, | |
$value, | |||
array | $settings, | ||
array | $options ) |
Convert a value to a string representation.
This is intended as the inverse of getValue() and validate(): this should accept anything returned by those methods or expected to be used as PARAM_DEFAULT, and if the string from this method is passed in as client input or PARAM_DEFAULT it should give equivalent output from validate().
string | $name | Parameter name being converted. |
mixed | $value | Parameter value being converted. Do not pass null. |
array | $settings | Parameter settings array. |
array | $options | Options array. |
Reimplemented from Wikimedia\ParamValidator\TypeDef.
Definition at line 51 of file IntegerDef.php.
References Wikimedia\ParamValidator\ParamValidator\implodeMultiValue().
Wikimedia\ParamValidator\TypeDef\IntegerDef::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 |
Reimplemented from Wikimedia\ParamValidator\TypeDef.
Reimplemented in Wikimedia\ParamValidator\TypeDef\LimitDef.
Definition at line 25 of file IntegerDef.php.
References Wikimedia\ParamValidator\TypeDef\NumericDef\checkRange(), and Wikimedia\ParamValidator\TypeDef\failure().