MediaWiki  master
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

 checkSettings (string $name, $settings, array $options, array $ret)
 Validate a parameter settings array. More...
 
 normalizeSettings (array $settings)
 Normalize a settings array Stable to override. More...
 
- 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. More...
 
 getParamInfo ( $name, array $settings, array $options)
 Describe parameter settings in a machine-readable format. More...
 
 validate ( $name, $value, array $settings, array $options)
 Validate the value. More...
 
- Public Member Functions inherited from Wikimedia\ParamValidator\TypeDef
 __construct (Callbacks $callbacks)
 Stable to call. 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 Stable to override. 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 Member Functions inherited from Wikimedia\ParamValidator\TypeDef
 failure ( $failure, $name, $value, array $settings, array $options, $fatal=true)
 Record a failure message. More...
 
 failureMessage ( $code, array $data=null, $suffix=null)
 Create a DataMessageValue representing a failure. 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

◆ checkSettings()

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.

See also
ParamValidator::checkSettings() Stable to override
Parameters
string$nameParameter name
array | mixed$settingsDefault value or an array of settings using PARAM_* constants.
array$optionsOptions 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\StringDef.

Definition at line 23 of file PasswordDef.php.

References Wikimedia\ParamValidator\ParamValidator\PARAM_SENSITIVE.

◆ normalizeSettings()

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

Normalize a settings array Stable to override.

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: