MediaWiki  master
Wikimedia\ParamValidator\TypeDef\StringDef Class Reference

Type definition for string types. More...

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

Public Member Functions

 __construct (Callbacks $callbacks, array $options=[])
 
 checkSettings (string $name, $settings, array $options, array $ret)
 Validate a parameter settings array. More...
 
 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)
 
 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...
 
 normalizeSettings (array $settings)
 Normalize a settings array. More...
 
 stringifyValue ( $name, $value, array $settings, array $options)
 Convert a value to a string representation. More...
 

Public Attributes

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

 $allowEmptyWhenRequired = false
 
- Protected Attributes inherited from Wikimedia\ParamValidator\TypeDef
Callbacks $callbacks
 

Additional Inherited Members

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

Detailed Description

Type definition for string types.

The result from validate() is a PHP string.

Failure codes:

  • 'missingparam': The parameter is the empty string (and that's not allowed). No data.

Additional codes may be generated when using certain PARAM constants. See the constants' documentation for details.

Since
1.34 @unstable

Definition at line 24 of file StringDef.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\ParamValidator\TypeDef\StringDef::__construct ( Callbacks  $callbacks,
array  $options = [] 
)
Parameters
Callbacks$callbacks
array$optionsOptions:
  • allowEmptyWhenRequired: (bool) Whether to reject the empty string when PARAM_REQUIRED. Defaults to false.

Definition at line 56 of file StringDef.php.

References Wikimedia\ParamValidator\TypeDef\$callbacks.

Member Function Documentation

◆ checkSettings()

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

Reimplemented in Wikimedia\ParamValidator\TypeDef\PasswordDef.

Definition at line 93 of file StringDef.php.

References Wikimedia\ParamValidator\TypeDef\StringDef\PARAM_MAX_BYTES, Wikimedia\ParamValidator\TypeDef\StringDef\PARAM_MAX_CHARS, and Wikimedia\ParamValidator\ParamValidator\PARAM_REQUIRED.

◆ getHelpInfo()

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

Parameters
string$nameParameter name being described.
array$settingsParameter settings array.
array$optionsOptions array.
Returns
(MessageValue|null)[]

Reimplemented from Wikimedia\ParamValidator\TypeDef.

Definition at line 139 of file StringDef.php.

References Wikimedia\Message\MessageValue\new(), Wikimedia\ParamValidator\TypeDef\StringDef\PARAM_MAX_BYTES, and Wikimedia\ParamValidator\TypeDef\StringDef\PARAM_MAX_CHARS.

◆ getParamInfo()

Wikimedia\ParamValidator\TypeDef\StringDef::getParamInfo (   $name,
array  $settings,
array  $options 
)

Describe parameter settings in a machine-readable format.

Keys should be short strings using lowercase ASCII letters. Values should generally be values that could be encoded in JSON or the like.

This is intended to handle PARAM constants specific to this class. It generally shouldn't handle constants defined on ParamValidator itself.

Parameters
string$nameParameter name.
array$settingsParameter settings array.
array$optionsOptions array.
Returns
array

Reimplemented from Wikimedia\ParamValidator\TypeDef.

Definition at line 130 of file StringDef.php.

References Wikimedia\ParamValidator\TypeDef\StringDef\PARAM_MAX_BYTES, and Wikimedia\ParamValidator\TypeDef\StringDef\PARAM_MAX_CHARS.

◆ validate()

Wikimedia\ParamValidator\TypeDef\StringDef::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$nameParameter name being validated.
mixed$valueValue to validate, from getValue().
array$settingsParameter settings array.
array$optionsOptions 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
ValidationExceptionif the value is invalid

Reimplemented from Wikimedia\ParamValidator\TypeDef.

Definition at line 62 of file StringDef.php.

References Wikimedia\ParamValidator\TypeDef\failure(), Wikimedia\ParamValidator\TypeDef\failureMessage(), and Wikimedia\ParamValidator\ParamValidator\PARAM_REQUIRED.

Member Data Documentation

◆ $allowEmptyWhenRequired

Wikimedia\ParamValidator\TypeDef\StringDef::$allowEmptyWhenRequired = false
protected

Definition at line 48 of file StringDef.php.

◆ PARAM_MAX_BYTES

const Wikimedia\ParamValidator\TypeDef\StringDef::PARAM_MAX_BYTES = 'param-max-bytes'

(integer) Maximum length of a string in bytes.

Failure codes:

  • 'maxbytes': The string is too long. Data:
    • 'maxbytes': The maximum number of bytes allowed, or null if no limit
    • 'maxchars': The maximum number of characters allowed, or null if no limit

Definition at line 34 of file StringDef.php.

Referenced by Wikimedia\ParamValidator\TypeDef\StringDef\checkSettings(), Wikimedia\ParamValidator\TypeDef\StringDef\getHelpInfo(), and Wikimedia\ParamValidator\TypeDef\StringDef\getParamInfo().

◆ PARAM_MAX_CHARS

const Wikimedia\ParamValidator\TypeDef\StringDef::PARAM_MAX_CHARS = 'param-max-chars'

(integer) Maximum length of a string in characters (Unicode codepoints).

The string is assumed to be encoded as UTF-8.

Failure codes:

  • 'maxchars': The string is too long. Data:
    • 'maxbytes': The maximum number of bytes allowed, or null if no limit
    • 'maxchars': The maximum number of characters allowed, or null if no limit

Definition at line 46 of file StringDef.php.

Referenced by Wikimedia\ParamValidator\TypeDef\StringDef\checkSettings(), Wikimedia\ParamValidator\TypeDef\StringDef\getHelpInfo(), and Wikimedia\ParamValidator\TypeDef\StringDef\getParamInfo().


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