MediaWiki REL1_34
|
Type definition for string types. More...
Public Member Functions | |
__construct (Callbacks $callbacks, array $options=[]) | |
validate ( $name, $value, array $settings, array $options) | |
Validate the value. | |
Public Member Functions inherited from Wikimedia\ParamValidator\TypeDef | |
__construct (Callbacks $callbacks) | |
describeSettings ( $name, array $settings, array $options) | |
"Describe" a settings array | |
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. | |
normalizeSettings (array $settings) | |
Normalize a settings array. | |
stringifyValue ( $name, $value, array $settings, array $options) | |
Convert a value to a string representation. | |
Public Attributes | |
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). | |
Protected Attributes | |
$allowEmptyWhenRequired = false | |
Protected Attributes inherited from Wikimedia\ParamValidator\TypeDef | |
Callbacks | $callbacks |
Type definition for string types.
The result from validate() is a PHP string.
ValidationException codes:
Additional codes may be generated when using certain PARAM constants. See the constants' documentation for details.
Definition at line 24 of file StringDef.php.
Wikimedia\ParamValidator\TypeDef\StringDef::__construct | ( | Callbacks | $callbacks, |
array | $options = [] |
||
) |
Callbacks | $callbacks | |
array | $options | Options:
|
Definition at line 56 of file StringDef.php.
References Wikimedia\ParamValidator\TypeDef\$callbacks.
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.
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:
|
ValidationException | if the value is invalid |
Reimplemented from Wikimedia\ParamValidator\TypeDef.
Definition at line 62 of file StringDef.php.
References Wikimedia\ParamValidator\ParamValidator\PARAM_REQUIRED.
|
protected |
Definition at line 48 of file StringDef.php.
const Wikimedia\ParamValidator\TypeDef\StringDef::PARAM_MAX_BYTES = 'param-max-bytes' |
(integer) Maximum length of a string in bytes.
ValidationException codes:
Definition at line 34 of file StringDef.php.
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.
ValidationException codes:
Definition at line 46 of file StringDef.php.