MediaWiki  master
Wikimedia\ParamValidator\TypeDef\IntegerDef Class Reference

Type definition for integer types. More...

Inheritance diagram for Wikimedia\ParamValidator\TypeDef\IntegerDef:
Collaboration diagram for Wikimedia\ParamValidator\TypeDef\IntegerDef:

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. Stable to override
Parameters
string$nameParameter name being described.
array$settingsParameter settings array.
array$optionsOptions array.
Returns
(MessageValue|null)[]
Stable to override Stable to override More...
 
 validate ( $name, $value, array $settings, array $options)
 Validate the value. More...
 
- 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.
See also
ParamValidator::checkSettings() Stable to override
Parameters
string$nameParameter name
array | mixed$settingsDefault value or an array of settings using PARAM_* constants.
array$optionsOptions array, passed through to the TypeDef and Callbacks.
array$ret
  • 'issues': (string[]) Errors detected in $settings, as English text. If the settings are valid, this will be the empty array. Keys on input are ParamValidator constants, allowing the typedef to easily override core validation; this need not be preserved when returned.
  • 'allowedKeys': (string[]) ParamValidator keys that are allowed in $settings.
  • 'messages': (MessageValue[]) Messages to be checked for existence.
Returns
array $ret, with any relevant changes.
Stable to override More...
 
 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. Stable to override
Parameters
string$nameParameter name.
array$settingsParameter settings array.
array$optionsOptions array.
Returns
array
Stable to override More...
 
 normalizeSettings (array $settings)
 Normalize a settings array Stable to override.
Parameters
array$settings
Returns
array
Stable to override More...
 
- Public Member Functions inherited from Wikimedia\ParamValidator\TypeDef
 __construct (Callbacks $callbacks)
 Stable to call. More...
 
 getEnumValues ( $name, array $settings, array $options)
 Get the values for enum-like parameters. More...
 
 getValue ( $name, array $settings, array $options)
 Get the value from the request Stable to override. More...
 
 stringifyValue ( $name, $value, array $settings, array $options)
 Convert a value to a string representation. More...
 

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. More...
 
const PARAM_MAX = 'param-max'
 (int|float) Maximum allowed value (normal limits) More...
 
const PARAM_MAX2 = 'param-max2'
 (int|float) Maximum allowed value (high limits) More...
 
const PARAM_MIN = 'param-min'
 (int|float) Minimum allowed value. More...
 
- Protected Member Functions inherited from Wikimedia\ParamValidator\TypeDef\NumericDef
 checkRange ( $value, $name, $origValue, array $settings, array $options)
 Check the range of a value. More...
 
- Protected Member Functions inherited from Wikimedia\ParamValidator\TypeDef
 failure ( $failure, $name, $value, array $settings, array $options, $fatal=true)
 Record a failure message. More...
 
 failureMessage ( $code, array $data=null, $suffix=null)
 Create a DataMessageValue representing a failure. More...
 
- Protected Attributes inherited from Wikimedia\ParamValidator\TypeDef\NumericDef
string $valueType = 'integer'
 PHP type (as from gettype()) of values this NumericDef handles. More...
 
- Protected Attributes inherited from Wikimedia\ParamValidator\TypeDef
Callbacks $callbacks
 

Detailed Description

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.

  • Failure codes:
    • 'badinteger': The value was invalid or could not be represented as a PHP integer. No data.
Since
1.34 @unstable

Definition at line 23 of file IntegerDef.php.

Member Function Documentation

◆ getHelpInfo()

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. Stable to override

Parameters
string$nameParameter name being described.
array$settingsParameter settings array.
array$optionsOptions array.
Returns
(MessageValue|null)[]
Stable to override Stable to override

Reimplemented from Wikimedia\ParamValidator\TypeDef\NumericDef.

Reimplemented in Wikimedia\ParamValidator\TypeDef\LimitDef.

Definition at line 42 of file IntegerDef.php.

References Wikimedia\Message\MessageValue\new(), Wikimedia\ParamValidator\ParamValidator\PARAM_ISMULTI, and Wikimedia\ParamValidator\ParamValidator\PARAM_TYPE.

◆ validate()

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.

Parameters
string$nameParameter name being validated.
mixed$valueValue to validate, from getValue().
array$settingsParameter settings array.
array$optionsOptions array. Note the following values that may be set by ParamValidator:
  • is-default: (bool) If present and true, the value was taken from PARAM_DEFAULT rather that being supplied by the client.
  • values-list: (string[]) If defined, values of a multi-valued parameter are being processed (and this array holds the full set of values).
Returns
mixed Validated value
Exceptions
ValidationExceptionif 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().


The documentation for this class was generated from the following file: