Type definition for "limit" types. More...

Inherits Wikimedia\ParamValidator\TypeDef\IntegerDef.

Collaboration diagram for Wikimedia\ParamValidator\TypeDef\LimitDef:

[legend]

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.

See also: ParamValidator::checkSettings()

Stability: stable: to override

Parameters

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	'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.

Stability: stable: to override

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.

Stability: stable: to override

Parameters

string	$name	Parameter name being described.
array	$settings	Parameter settings array.
array	$options	Options array.

Returns: (MessageValue|null)[]

Stability: stable: to override

Stability: stable: to override

normalizeSettings (array $settings)

Normalize a settings array.

Stability: stable: to override

Parameters

array $settings

Returns: array

Stability: stable: to override

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	$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: 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

ValidationException if the value is invalid

Public Member Functions inherited from Wikimedia\ParamValidator\TypeDef\IntegerDef

stringifyValue ( $name, $value, array $settings, array $options)

Convert a value to a string representation.

Public Member Functions inherited from Wikimedia\ParamValidator\TypeDef\NumericDef

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.

Stability: stable: to override

Parameters

string	$name	Parameter name.
array	$settings	Parameter settings array.
array	$options	Options array.

Returns: 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.

supportsArrays ()

Whether the value may be an array.

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.

Public Attributes inherited from Wikimedia\ParamValidator\TypeDef
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'

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
	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.

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

Detailed Description

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.

See also: IntegerDef

Since: 1.34

Stability: unstable

Definition at line 18 of file LimitDef.php.

Member Function Documentation

◆ checkSettings()

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.

See also: ParamValidator::checkSettings()

Stability: stable: to override

Parameters

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	'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.

Stability: stable: to override

Stability: stable: to override

Reimplemented from Wikimedia\ParamValidator\TypeDef\NumericDef.

Definition at line 51 of file LimitDef.php.

References Wikimedia\ParamValidator\ParamValidator\PARAM_ISMULTI.

◆ getHelpInfo()

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.

Stability: stable: to override

Parameters

string	$name	Parameter name being described.
array	$settings	Parameter settings array.
array	$options	Options array.

Returns: (MessageValue|null)[]

Stability: stable: to override

Stability: stable: to override

Stability: stable: to override

Reimplemented from Wikimedia\ParamValidator\TypeDef\IntegerDef.

Definition at line 71 of file LimitDef.php.

References Wikimedia\ParamValidator\ParamValidator\PARAM_TYPE.

◆ normalizeSettings()

Wikimedia\ParamValidator\TypeDef\LimitDef::normalizeSettings ( array $settings )

Normalize a settings array.

Stability: stable: to override

Parameters

array $settings

Returns: array

Stability: stable: to override

Stability: stable: to override

Reimplemented from Wikimedia\ParamValidator\TypeDef\NumericDef.

Definition at line 40 of file LimitDef.php.

References Wikimedia\ParamValidator\ParamValidator\PARAM_ISMULTI.

◆ validate()

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.

Parameters

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: 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

ValidationException if the value is invalid

Additional $options accepted:

'parse-limit': (bool) Default true, set false to return 'max' rather than determining the effective value.

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.

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

includes/libs/ParamValidator/TypeDef/LimitDef.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ checkSettings()

◆ getHelpInfo()

◆ normalizeSettings()

◆ validate()