MediaWiki  master
Wikimedia\ParamValidator\ParamValidator\TypeDef\TagsDef Class Reference

Type definition for tags type. More...

Inheritance diagram for Wikimedia\ParamValidator\ParamValidator\TypeDef\TagsDef:
Collaboration diagram for Wikimedia\ParamValidator\ParamValidator\TypeDef\TagsDef:

Public Member Functions

 __construct (Callbacks $callbacks)
 Stable to call. More...
 
 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...
 
- Public Member Functions inherited from Wikimedia\ParamValidator\TypeDef\EnumDef
 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...
 
- Public Member Functions inherited from Wikimedia\ParamValidator\TypeDef
 getValue ( $name, array $settings, array $options)
 Get the value from the request Stable to override. More...
 
 normalizeSettings (array $settings)
 Normalize a settings array Stable to override. More...
 

Private Attributes

MessageConverter $messageConverter
 

Additional Inherited Members

- Public Attributes inherited from Wikimedia\ParamValidator\TypeDef\EnumDef
const PARAM_DEPRECATED_VALUES = 'param-deprecated-values'
 (array) Associative array of deprecated values. More...
 
- Protected Member Functions inherited from Wikimedia\ParamValidator\TypeDef\EnumDef
 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...
 
- Protected Member Functions inherited from Wikimedia\ParamValidator\TypeDef
 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...
 
- Protected Attributes inherited from Wikimedia\ParamValidator\TypeDef
Callbacks $callbacks
 

Detailed Description

Type definition for tags type.

A tags type is an enum type for selecting MediaWiki change tags.

Failure codes:

  • 'badtags': The value was not a valid set of tags. Data:
    • 'disallowedtags': The tags that were disallowed.
Since
1.35

Definition at line 23 of file TagsDef.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\ParamValidator\ParamValidator\TypeDef\TagsDef::__construct ( Callbacks  $callbacks)

Stable to call.

Parameters
Callbacks$callbacks

Reimplemented from Wikimedia\ParamValidator\TypeDef.

Definition at line 28 of file TagsDef.php.

References Wikimedia\ParamValidator\TypeDef\$callbacks.

Member Function Documentation

◆ getEnumValues()

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. Stable to override

Parameters
string$nameParameter name being validated.
array$settingsParameter settings array.
array$optionsOptions array.
Returns
array|null All possible enumerated values, or null if this is not an enumeration.

Reimplemented from Wikimedia\ParamValidator\TypeDef\EnumDef.

Definition at line 70 of file TagsDef.php.

References ChangeTags\listExplicitlyDefinedTags().

◆ validate()

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.

Parameters
string$nameParameter name being validated.
mixed$valueValue to validate, from getValue().
array$settingsParameter settings array.
array$optionsOptions array. Note the following values that may be set by ParamValidator:
  • is-default: (bool) If present and true, the value was taken from PARAM_DEFAULT rather that being supplied by the client.
  • values-list: (string[]) If defined, values of a multi-valued parameter are being processed (and this array holds the full set of values).
Returns
mixed Validated value
Exceptions
ValidationExceptionif the value is invalid

Reimplemented from Wikimedia\ParamValidator\TypeDef\EnumDef.

Definition at line 33 of file TagsDef.php.

References ChangeTags\canAddTagsAccompanyingChange(), and Wikimedia\Message\DataMessageValue\new().

Member Data Documentation

◆ $messageConverter

MessageConverter Wikimedia\ParamValidator\ParamValidator::TypeDef\TagsDef::$messageConverter
private

Definition at line 26 of file TagsDef.php.


The documentation for this class was generated from the following file: