Type definition for timestamp types. More...

Inherits Wikimedia\ParamValidator\TypeDef.

Collaboration diagram for Wikimedia\ParamValidator\TypeDef\TimestampDef:

[legend]

Public Member Functions

__construct (Callbacks $callbacks, array $options=[])

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

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

Parameters

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.

Returns: string|null Return null if there is no representation of $value reasonably satisfying the description given.

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.

supportsArrays ()

Whether the value may be an array.

Public Attributes
const	PARAM_TIMESTAMP_FORMAT = 'param-timestamp-format'
	(string\|int) Timestamp format to return from validate()

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 Attributes
string int	$defaultFormat

int	$stringifyFormat

Protected Attributes inherited from Wikimedia\ParamValidator\TypeDef
Callbacks	$callbacks

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.

Detailed Description

Type definition for timestamp types.

This uses the wikimedia/timestamp library for parsing and formatting the timestamps.

The result from validate() is a ConvertibleTimestamp by default, but this may be changed by both a constructor option and a PARAM constant.

Failure codes:

'badtimestamp': The timestamp is not valid. No data, but the TimestampException is available via Exception::getPrevious().
'unclearnowtimestamp': Non-fatal. The value is the empty string or "0". Use 'now' instead if you really want the current timestamp. No data.

Since: 1.34

Stability: unstable

Definition at line 33 of file TimestampDef.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\ParamValidator\TypeDef\TimestampDef::__construct	(	Callbacks	$callbacks,
		array	$options = [] )

Parameters

Callbacks	$callbacks
array	$options	Options: defaultFormat: (string\|int) Default for PARAM_TIMESTAMP_FORMAT. Default if not specified is 'ConvertibleTimestamp'. stringifyFormat: (int) Format to use for stringifyValue(). Default is TS::ISO_8601.

Definition at line 61 of file TimestampDef.php.

References Wikimedia\ParamValidator\TypeDef\$callbacks.

Member Function Documentation

◆ checkSettings()

Wikimedia\ParamValidator\TypeDef\TimestampDef::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 127 of file TimestampDef.php.

◆ getHelpInfo()

Wikimedia\ParamValidator\TypeDef\TimestampDef::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 149 of file TimestampDef.php.

◆ stringifyValue()

Wikimedia\ParamValidator\TypeDef\TimestampDef::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().

Parameters

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.

Returns: string|null Return null if there is no representation of $value reasonably satisfying the description given.

Reimplemented from Wikimedia\ParamValidator\TypeDef.

Definition at line 141 of file TimestampDef.php.

◆ validate()

Wikimedia\ParamValidator\TypeDef\TimestampDef::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 92 of file TimestampDef.php.

Member Data Documentation

◆ $defaultFormat

string int Wikimedia\ParamValidator\TypeDef\TimestampDef::$defaultFormat

protected

Definition at line 48 of file TimestampDef.php.

◆ $stringifyFormat

int Wikimedia\ParamValidator\TypeDef\TimestampDef::$stringifyFormat

protected

Definition at line 51 of file TimestampDef.php.

◆ PARAM_TIMESTAMP_FORMAT

const Wikimedia\ParamValidator\TypeDef\TimestampDef::PARAM_TIMESTAMP_FORMAT = 'param-timestamp-format'

(string|int) Timestamp format to return from validate()

Values include:

'ConvertibleTimestamp': A ConvertibleTimestamp object.
'DateTime': A PHP DateTime object
One of ConvertibleTimestamp's TS::* constants.

This does not affect the format returned by stringifyValue().

Definition at line 45 of file TimestampDef.php.

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

includes/libs/ParamValidator/TypeDef/TimestampDef.php

Public Member Functions

Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkSettings()

◆ getHelpInfo()

◆ stringifyValue()

◆ validate()

Member Data Documentation

◆ $defaultFormat

◆ $stringifyFormat

◆ PARAM_TIMESTAMP_FORMAT