MediaWiki
master
|
Type definition for tags type. More...
Public Member Functions | |
__construct (Callbacks $callbacks, ChangeTagsStore $changeTagsStore) | |
getEnumValues ( $name, array $settings, array $options) | |
Get the values for enum-like parameters. More... | |
validate ( $name, $value, array $settings, array $options) | |
Validate the value. More... | |
![]() | |
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... | |
stringifyValue ( $name, $value, array $settings, array $options) | |
Convert a value to a string representation. More... | |
![]() | |
__construct (Callbacks $callbacks) | |
getValue ( $name, array $settings, array $options) | |
Get the value from the request. More... | |
normalizeSettings (array $settings) | |
Normalize a settings array. More... | |
Additional Inherited Members | |
![]() | |
const | PARAM_DEPRECATED_VALUES = 'param-deprecated-values' |
(array) Associative array of deprecated values. More... | |
![]() | |
getEnumValuesForHelp ( $name, array $settings, array $options) | |
Return enum values formatted for the help message. More... | |
sortEnumValues (string $name, array $values, array $settings, array $options) | |
Sort enum values for help/param info output. More... | |
![]() | |
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... | |
![]() | |
Callbacks | $callbacks |
Type definition for tags type.
A tags type is an enum type for selecting MediaWiki change tags.
Failure codes:
Definition at line 24 of file TagsDef.php.
Wikimedia\ParamValidator\ParamValidator\TypeDef\TagsDef::__construct | ( | Callbacks | $callbacks, |
ChangeTagsStore | $changeTagsStore | ||
) |
Definition at line 31 of file TagsDef.php.
References Wikimedia\ParamValidator\TypeDef\$callbacks.
Wikimedia\ParamValidator\ParamValidator\TypeDef\TagsDef::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 74 of file TagsDef.php.
Wikimedia\ParamValidator\ParamValidator\TypeDef\TagsDef::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 37 of file TagsDef.php.
References ChangeTags\canAddTagsAccompanyingChange(), and Wikimedia\Message\DataMessageValue\new().