MediaWiki REL1_39
|
Type definition for enumeration types. More...
Public Member Functions | |
checkSettings (string $name, $settings, array $options, array $ret) | |
Validate a parameter settings array. | |
getEnumValues ( $name, array $settings, array $options) | |
Get the values for enum-like parameters. | |
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. | |
stringifyValue ( $name, $value, array $settings, array $options) | |
Convert a value to a string representation. | |
validate ( $name, $value, array $settings, array $options) | |
Validate the value. | |
Public Member Functions inherited from Wikimedia\ParamValidator\TypeDef | |
__construct (Callbacks $callbacks) | |
getValue ( $name, array $settings, array $options) | |
Get the value from the request. | |
normalizeSettings (array $settings) | |
Normalize a settings array. | |
Public Attributes | |
const | PARAM_DEPRECATED_VALUES = 'param-deprecated-values' |
(array) Associative array of deprecated values. | |
Protected Member Functions | |
getEnumValuesForHelp ( $name, array $settings, array $options) | |
Return enum values formatted for the help message. | |
sortEnumValues (string $name, array $values, array $settings, array $options) | |
Sort enum values for help/param info output. | |
Protected Member Functions inherited from Wikimedia\ParamValidator\TypeDef | |
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. | |
Additional Inherited Members | |
Protected Attributes inherited from Wikimedia\ParamValidator\TypeDef | |
Callbacks | $callbacks |
Type definition for enumeration types.
This class expects that PARAM_TYPE is an array of allowed values. Subclasses may override getEnumValues() to determine the allowed values differently.
The result from validate() is one of the defined values.
Failure codes:
Additional codes may be generated when using certain PARAM constants. See the constants' documentation for details.
Definition at line 32 of file EnumDef.php.
Wikimedia\ParamValidator\TypeDef\EnumDef::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 MediaWiki\Api\Validator\SubmoduleDef, and MediaWiki\ParamValidator\TypeDef\NamespaceDef.
Definition at line 87 of file EnumDef.php.
References Wikimedia\ParamValidator\TypeDef\EnumDef\PARAM_DEPRECATED_VALUES.
Wikimedia\ParamValidator\TypeDef\EnumDef::getEnumValues | ( | $name, | |
array | $settings, | ||
array | $options ) |
Get the values for enum-like parameters.
This is primarily intended for documentation and implementation of PARAM_ALL; it is the responsibility of the TypeDef to ensure that validate() accepts the values returned here.
string | $name | Parameter name being validated. |
array | $settings | Parameter settings array. |
array | $options | Options array. |
Reimplemented from Wikimedia\ParamValidator\TypeDef.
Reimplemented in MediaWiki\Api\Validator\SubmoduleDef, MediaWiki\ParamValidator\TypeDef\NamespaceDef, and MediaWiki\ParamValidator\TypeDef\TagsDef.
Definition at line 118 of file EnumDef.php.
References Wikimedia\ParamValidator\ParamValidator\PARAM_TYPE.
Referenced by Wikimedia\ParamValidator\TypeDef\EnumDef\validate().
|
protected |
Return enum values formatted for the help message.
string | $name | Parameter name being described. |
array | $settings | Parameter settings array. |
array | $options | Options array. |
Reimplemented in MediaWiki\Api\Validator\SubmoduleDef.
Definition at line 217 of file EnumDef.php.
Wikimedia\ParamValidator\TypeDef\EnumDef::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 154 of file EnumDef.php.
References Wikimedia\Message\ListType\COMMA, Wikimedia\ParamValidator\ParamValidator\PARAM_ISMULTI, and Wikimedia\ParamValidator\ParamValidator\PARAM_TYPE.
Wikimedia\ParamValidator\TypeDef\EnumDef::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.
Reimplemented in MediaWiki\Api\Validator\SubmoduleDef, and MediaWiki\ParamValidator\TypeDef\NamespaceDef.
Definition at line 130 of file EnumDef.php.
References Wikimedia\ParamValidator\TypeDef\getEnumValues().
|
protected |
Sort enum values for help/param info output.
string | $name | Parameter name being described. |
string[] | $values | Values being sorted |
array | $settings | Parameter settings array. |
array | $options | Options array. |
Reimplemented in MediaWiki\Api\Validator\SubmoduleDef.
Definition at line 192 of file EnumDef.php.
Wikimedia\ParamValidator\TypeDef\EnumDef::stringifyValue | ( | $name, | |
$value, | |||
array | $settings, | ||
array | $options ) |
Convert a value to a string representation.
This is intended as the inverse of getValue() and validate(): this should accept anything returned by those methods or expected to be used as PARAM_DEFAULT, and if the string from this method is passed in as client input or PARAM_DEFAULT it should give equivalent output from validate().
string | $name | Parameter name being converted. |
mixed | $value | Parameter value being converted. Do not pass null. |
array | $settings | Parameter settings array. |
array | $options | Options array. |
Reimplemented from Wikimedia\ParamValidator\TypeDef.
Definition at line 122 of file EnumDef.php.
References Wikimedia\ParamValidator\ParamValidator\implodeMultiValue().
Wikimedia\ParamValidator\TypeDef\EnumDef::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.
Reimplemented in MediaWiki\ParamValidator\TypeDef\NamespaceDef, and MediaWiki\ParamValidator\TypeDef\TagsDef.
Definition at line 51 of file EnumDef.php.
References Wikimedia\ParamValidator\TypeDef\failure(), Wikimedia\ParamValidator\TypeDef\failureMessage(), Wikimedia\Message\DataMessageValue\getData(), Wikimedia\ParamValidator\TypeDef\EnumDef\getEnumValues(), Wikimedia\ParamValidator\TypeDef\EnumDef\PARAM_DEPRECATED_VALUES, and Wikimedia\Message\ParamType\PLAINTEXT.
const Wikimedia\ParamValidator\TypeDef\EnumDef::PARAM_DEPRECATED_VALUES = 'param-deprecated-values' |
(array) Associative array of deprecated values.
Keys are the deprecated parameter values. Value is one of the following:
Note that this does not add any values to the enumeration, it only documents existing values as being deprecated.
Failure codes: (non-fatal)
Definition at line 49 of file EnumDef.php.
Referenced by Wikimedia\ParamValidator\TypeDef\EnumDef\checkSettings(), and Wikimedia\ParamValidator\TypeDef\EnumDef\validate().