MediaWiki master
|
Type definition for string types. More...
Inherits Wikimedia\ParamValidator\TypeDef.
Inherited by Wikimedia\ParamValidator\TypeDef\PasswordDef.
Public Member Functions | |
__construct (Callbacks $callbacks, array $options=[]) | |
checkSettings (string $name, $settings, array $options, array $ret) | |
Validate a parameter settings array. | |
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. | |
![]() | |
__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. | |
normalizeSettings (array $settings) | |
Normalize a settings array. | |
stringifyValue ( $name, $value, array $settings, array $options) | |
Convert a value to a string representation. | |
supportsArrays () | |
Whether the value may be an array. | |
Public Attributes | |
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). | |
![]() | |
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 Attributes | |
bool | $allowEmptyWhenRequired = false |
![]() | |
Callbacks | $callbacks |
Additional Inherited Members | |
![]() | |
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. | |
Type definition for string types.
The result from validate() is a PHP string.
Failure 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 62 of file StringDef.php.
References Wikimedia\ParamValidator\TypeDef\$callbacks.
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.
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 |
|
Reimplemented from Wikimedia\ParamValidator\TypeDef.
Reimplemented in Wikimedia\ParamValidator\TypeDef\PasswordDef.
Definition at line 104 of file StringDef.php.
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.
string | $name | Parameter name being described. |
array | $settings | Parameter settings array. |
array | $options | Options array. |
Reimplemented from Wikimedia\ParamValidator\TypeDef.
Definition at line 150 of file StringDef.php.
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.
string | $name | Parameter name. |
array | $settings | Parameter settings array. |
array | $options | Options array. |
Reimplemented from Wikimedia\ParamValidator\TypeDef.
Definition at line 141 of file StringDef.php.
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 68 of file StringDef.php.
References Wikimedia\ParamValidator\TypeDef\StringDef\$allowEmptyWhenRequired, Wikimedia\ParamValidator\TypeDef\failIfNotString(), Wikimedia\ParamValidator\TypeDef\failure(), Wikimedia\ParamValidator\TypeDef\failureMessage(), Wikimedia\ParamValidator\TypeDef\StringDef\OPT_ALLOW_EMPTY, and Wikimedia\ParamValidator\ParamValidator\PARAM_REQUIRED.
|
protected |
Definition at line 54 of file StringDef.php.
Referenced by Wikimedia\ParamValidator\TypeDef\StringDef\validate().
const Wikimedia\ParamValidator\TypeDef\StringDef::OPT_ALLOW_EMPTY = 'allowEmptyWhenRequired' |
When this option is set, the empty string is considered a proper value.
Definition at line 29 of file StringDef.php.
Referenced by Wikimedia\ParamValidator\TypeDef\StringDef\validate().
const Wikimedia\ParamValidator\TypeDef\StringDef::PARAM_MAX_BYTES = 'param-max-bytes' |
(integer) Maximum length of a string in bytes.
Failure codes:
Definition at line 39 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.
Failure codes:
Definition at line 51 of file StringDef.php.