Type definition for tags type. More...

Inherits Wikimedia\ParamValidator\TypeDef\EnumDef.

Collaboration diagram for MediaWiki\ParamValidator\TypeDef\TagsDef:

[legend]

Public Member Functions
	__construct (Callbacks $callbacks, ChangeTagsStore $changeTagsStore)

	getEnumValues ( $name, array $settings, array $options)
	Get the values for enum-like parameters.

	validate ( $name, $value, array $settings, array $options)
	Validate the value.

Public Member Functions inherited from Wikimedia\ParamValidator\TypeDef\EnumDef
	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.

	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.

	normalizeSettings (array $settings)
	Normalize a settings array.

	supportsArrays ()
	Whether the value may be an array.

Additional Inherited Members
Public Attributes inherited from Wikimedia\ParamValidator\TypeDef\EnumDef
const	PARAM_DEPRECATED_VALUES = 'param-deprecated-values'
	(array) Associative array of deprecated values.

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
	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.

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 24 of file TagsDef.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\ParamValidator\TypeDef\TagsDef::__construct	(	Callbacks	$callbacks,
		ChangeTagsStore	$changeTagsStore )

Definition at line 31 of file TagsDef.php.

References Wikimedia\ParamValidator\TypeDef\$callbacks.

Member Function Documentation

◆ getEnumValues()

MediaWiki\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.

Stability: stable: to override

Parameters

string	$name	Parameter name being validated.
array	$settings	Parameter settings array.
array	$options	Options 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 74 of file TagsDef.php.

◆ validate()

MediaWiki\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	$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: 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

ValidationException if the value is invalid

Reimplemented from Wikimedia\ParamValidator\TypeDef\EnumDef.

Definition at line 37 of file TagsDef.php.

References ChangeTags\canAddTagsAccompanyingChange().

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

includes/ParamValidator/TypeDef/TagsDef.php