Type definition for expiry timestamps. More...

Inherits Wikimedia\ParamValidator\TypeDef.

Collaboration diagram for Wikimedia\ParamValidator\TypeDef\ExpiryDef:

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

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)[]

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

__construct (Callbacks $callbacks)

getEnumValues ( $name, array $settings, array $options)

Get the values for enum-like parameters.

getParamInfo ( $name, array $settings, array $options)

Describe parameter settings in a machine-readable format.

getValue ( $name, array $settings, array $options)

Get the value from the request.

normalizeSettings (array $settings)

Normalize a settings array.

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

Convert a value to a string representation.

supportsArrays ()

Whether the value may be an array.

Static Public Member Functions
static	normalizeExpiry (?string $expiry=null, ?int $style=null)
	Normalize a user-inputted expiry in ConvertibleTimestamp.

static	normalizeUsingMaxExpiry (?string $expiry, ?string $maxExpiryDuration, ?int $style)
	Returns a normalized expiry or the max expiry if the given expiry exceeds it.

Public Attributes
const	PARAM_MAX = 'param-max'
	(int\|float) Maximum non-infinity duration.

const	PARAM_USE_MAX = 'param-use-max'
	(bool) If truthy, the value given for the PARAM_MAX setting is used if the provided expiry exceeds it, and the 'badexpiry-duration' message is shown as a warning.

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'

Additional Inherited Members
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
Callbacks	$callbacks

Detailed Description

Type definition for expiry timestamps.

Since: 1.35

Definition at line 17 of file ExpiryDef.php.

Member Function Documentation

◆ checkSettings()

Wikimedia\ParamValidator\TypeDef\ExpiryDef::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.

Reimplemented from Wikimedia\ParamValidator\TypeDef.

Definition at line 151 of file ExpiryDef.php.

References Wikimedia\ParamValidator\TypeDef\checkSettings().

◆ getHelpInfo()

Wikimedia\ParamValidator\TypeDef\ExpiryDef::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)[]

Reimplemented from Wikimedia\ParamValidator\TypeDef.

Definition at line 69 of file ExpiryDef.php.

References Wikimedia\ParamValidator\ParamValidator\PARAM_ISMULTI, and Wikimedia\ParamValidator\ParamValidator\PARAM_TYPE.

◆ normalizeExpiry()

static Wikimedia\ParamValidator\TypeDef\ExpiryDef::normalizeExpiry	(	?string	$expiry = null,
		?int	$style = null )

static

Normalize a user-inputted expiry in ConvertibleTimestamp.

Parameters

string \| null	$expiry
int \| null	$style	null or in a format acceptable to ConvertibleTimestamp (TS_* constants)

Returns: ConvertibleTimestamp|string|null Timestamp as ConvertibleTimestamp if $style is null, a string timestamp in $style is not null, 'infinity' if $expiry is one of the self::INFINITY_VALS, or null if $expiry is null.

Exceptions

InvalidArgumentException if $expiry is invalid

Definition at line 96 of file ExpiryDef.php.

Referenced by Wikimedia\ParamValidator\TypeDef\ExpiryDef\validate().

◆ normalizeUsingMaxExpiry()

static Wikimedia\ParamValidator\TypeDef\ExpiryDef::normalizeUsingMaxExpiry	(	?string	$expiry,
		?string	$maxExpiryDuration,
		?int	$style )

static

Returns a normalized expiry or the max expiry if the given expiry exceeds it.

Parameters

string \| null	$expiry
string \| null	$maxExpiryDuration
int \| null	$style	null or in a format acceptable to ConvertibleTimestamp (TS_* constants)

Returns: ConvertibleTimestamp|string|null Timestamp as ConvertibleTimestamp if $style is null, a string timestamp in $style is not null, 'infinity' if $expiry is one of the self::INFINITY_VALS, or null if $expiry is null.

Definition at line 143 of file ExpiryDef.php.

◆ validate()

Wikimedia\ParamValidator\TypeDef\ExpiryDef::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

Reimplemented from Wikimedia\ParamValidator\TypeDef.

Definition at line 36 of file ExpiryDef.php.

References Wikimedia\ParamValidator\TypeDef\failIfNotString(), Wikimedia\ParamValidator\TypeDef\failure(), Wikimedia\ParamValidator\TypeDef\fatal(), Wikimedia\ParamValidator\TypeDef\ExpiryDef\normalizeExpiry(), and Wikimedia\ParamValidator\TypeDef\ExpiryDef\PARAM_MAX.

Member Data Documentation

◆ PARAM_MAX

const Wikimedia\ParamValidator\TypeDef\ExpiryDef::PARAM_MAX = 'param-max'

(int|float) Maximum non-infinity duration.

Definition at line 33 of file ExpiryDef.php.

Referenced by Wikimedia\ParamValidator\TypeDef\ExpiryDef\validate().

◆ PARAM_USE_MAX

const Wikimedia\ParamValidator\TypeDef\ExpiryDef::PARAM_USE_MAX = 'param-use-max'

(bool) If truthy, the value given for the PARAM_MAX setting is used if the provided expiry exceeds it, and the 'badexpiry-duration' message is shown as a warning.

If false, 'badexpiry-duration' is shown and is fatal.

Definition at line 28 of file ExpiryDef.php.

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

includes/libs/ParamValidator/TypeDef/ExpiryDef.php

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ checkSettings()

◆ getHelpInfo()

◆ normalizeExpiry()

◆ normalizeUsingMaxExpiry()

◆ validate()

Member Data Documentation

◆ PARAM_MAX

◆ PARAM_USE_MAX