MediaWiki  1.34.0
Wikimedia\ParamValidator\TypeDef\PasswordDef Class Reference

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

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

Public Member Functions

 normalizeSettings (array $settings)
 Normalize a settings array. More...
 
- Public Member Functions inherited from Wikimedia\ParamValidator\TypeDef\StringDef
 __construct (Callbacks $callbacks, array $options=[])
 
 validate ( $name, $value, array $settings, array $options)
 Validate the value. More...
 
- Public Member Functions inherited from Wikimedia\ParamValidator\TypeDef
 __construct (Callbacks $callbacks)
 
 describeSettings ( $name, array $settings, array $options)
 "Describe" a settings array 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. 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\StringDef
const PARAM_MAX_BYTES = 'param-max-bytes'
 (integer) Maximum length of a string in bytes. More...
 
const PARAM_MAX_CHARS = 'param-max-chars'
 (integer) Maximum length of a string in characters (Unicode codepoints). More...
 
- Protected Attributes inherited from Wikimedia\ParamValidator\TypeDef\StringDef
 $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.

See also
StringDef
Since
1.34 @unstable

Definition at line 16 of file PasswordDef.php.

Member Function Documentation

◆ normalizeSettings()

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

Normalize a settings array.

Parameters
array$settings
Returns
array

Reimplemented from Wikimedia\ParamValidator\TypeDef.

Definition at line 18 of file PasswordDef.php.

References Wikimedia\ParamValidator\ParamValidator\PARAM_SENSITIVE.


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