MediaWiki master
|
Type definition for namespace types. More...
Inherits Wikimedia\ParamValidator\TypeDef\EnumDef.
Public Member Functions | |
__construct (Callbacks $callbacks, NamespaceInfo $nsInfo) | |
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. | |
getParamInfo ( $name, array $settings, array $options) | |
Describe parameter settings in a machine-readable format. | |
normalizeSettings (array $settings) | |
Normalize a settings array. | |
validate ( $name, $value, array $settings, array $options) | |
Validate the value. | |
Public Member Functions inherited from Wikimedia\ParamValidator\TypeDef\EnumDef | |
getHelpInfo ( $name, array $settings, array $options) | |
Describe parameter settings in human-readable format. | |
stringifyValue ( $name, $value, array $settings, array $options) | |
Convert a value to a string representation. | |
Public Member Functions inherited from Wikimedia\ParamValidator\TypeDef | |
__construct (Callbacks $callbacks) | |
getValue ( $name, array $settings, array $options) | |
Get the value from the request. | |
supportsArrays () | |
Whether the value may be an array. | |
Public Attributes | |
const | PARAM_EXTRA_NAMESPACES = 'param-extra-namespaces' |
(int[]) Additional namespace IDs to recognize. | |
Public Attributes inherited from Wikimedia\ParamValidator\TypeDef\EnumDef | |
const | PARAM_DEPRECATED_VALUES = 'param-deprecated-values' |
(array) Associative array of deprecated values. | |
Public Attributes inherited from Wikimedia\ParamValidator\TypeDef | |
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' |
Additional Inherited Members | |
Protected Member Functions inherited from Wikimedia\ParamValidator\TypeDef\EnumDef | |
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 | |
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. | |
Protected Attributes inherited from Wikimedia\ParamValidator\TypeDef | |
Callbacks | $callbacks |
Type definition for namespace types.
A namespace type is an enum type that accepts MediaWiki namespace IDs.
Definition at line 18 of file NamespaceDef.php.
MediaWiki\ParamValidator\TypeDef\NamespaceDef::__construct | ( | Callbacks | $callbacks, |
NamespaceInfo | $nsInfo ) |
Definition at line 30 of file NamespaceDef.php.
References Wikimedia\ParamValidator\TypeDef\$callbacks.
MediaWiki\ParamValidator\TypeDef\NamespaceDef::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\EnumDef.
Definition at line 62 of file NamespaceDef.php.
MediaWiki\ParamValidator\TypeDef\NamespaceDef::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\EnumDef.
Definition at line 44 of file NamespaceDef.php.
References MediaWiki\ParamValidator\TypeDef\NamespaceDef\PARAM_EXTRA_NAMESPACES.
MediaWiki\ParamValidator\TypeDef\NamespaceDef::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\EnumDef.
Definition at line 95 of file NamespaceDef.php.
MediaWiki\ParamValidator\TypeDef\NamespaceDef::normalizeSettings | ( | array | $settings | ) |
Normalize a settings array.
array | $settings |
Reimplemented from Wikimedia\ParamValidator\TypeDef.
Definition at line 54 of file NamespaceDef.php.
MediaWiki\ParamValidator\TypeDef\NamespaceDef::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\EnumDef.
Definition at line 35 of file NamespaceDef.php.
const MediaWiki\ParamValidator\TypeDef\NamespaceDef::PARAM_EXTRA_NAMESPACES = 'param-extra-namespaces' |
(int[]) Additional namespace IDs to recognize.
Generally this will be used to include NS_SPECIAL and/or NS_MEDIA.
Definition at line 25 of file NamespaceDef.php.
Referenced by MediaWiki\ParamValidator\TypeDef\NamespaceDef\getEnumValues().