Type definition for "password" types. More...

Collaboration diagram for Wikimedia\ParamValidator\TypeDef\PasswordDef:

[legend]

Public Member Functions
	checkSettings (string $name, $settings, array $options, array $ret)
	Validate a parameter settings array.

	normalizeSettings (array $settings)
	Normalize a settings array.

Public Member Functions inherited from Wikimedia\ParamValidator\TypeDef\StringDef
	__construct (Callbacks $callbacks, array $options=[])

	getHelpInfo ( $name, array $settings, array $options)
	Describe parameter settings in human-readable format.

	getParamInfo ( $name, array $settings, array $options)
	Describe parameter settings in a machine-readable format.

	validate ( $name, $value, array $settings, array $options)
	Validate the value.

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.

	stringifyValue ( $name, $value, array $settings, array $options)
	Convert a value to a string representation.

	supportsArrays ()
	Whether the value may be an array.

Additional Inherited Members
Public Attributes inherited from Wikimedia\ParamValidator\TypeDef\StringDef
const	OPT_ALLOW_EMPTY = 'allowEmptyWhenRequired'
	When this option is set, the empty string is considered a proper value.

const	PARAM_MAX_BYTES = 'param-max-bytes'
	(integer) Maximum length of a string in bytes.

const	PARAM_MAX_CHARS = 'param-max-chars'
	(integer) Maximum length of a string in characters (Unicode codepoints).

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
	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\StringDef
bool	$allowEmptyWhenRequired = false

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

Detailed Description

Type definition for "password" types.

This is a string type that forces PARAM_SENSITIVE = true.

Definition at line 16 of file PasswordDef.php.

Member Function Documentation

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

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.