Type definition for submodule types. More...

Inherits Wikimedia\ParamValidator\TypeDef\EnumDef.

Collaboration diagram for MediaWiki\Api\Validator\SubmoduleDef:

[legend]

Public Member Functions

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.

See also: ParamValidator::checkSettings()

Stability: stable: to override

Parameters

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	'issues': (string[]) Errors detected in $settings, as English text. If the settings are valid, this will be the empty array. Keys on input are ParamValidator constants, allowing the typedef to easily override core validation; this need not be preserved when returned. 'allowedKeys': (string[]) ParamValidator keys that are allowed in `$settings`. 'messages': (MessageValue[]) Messages to be checked for existence.

Returns: array $ret, with any relevant changes.

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.

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.

Stability: stable: to override

Parameters

string	$name	Parameter name.
array	$settings	Parameter settings array.
array	$options	Options array.

Returns: array

Public Member Functions inherited from 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.

Stability: stable: to override

Parameters

string	$name	Parameter name being described.
array	$settings	Parameter settings array.
array	$options	Options array.

Returns: (MessageValue|null)[]

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

Parameters

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.

Returns: string|null Return null if there is no representation of $value reasonably satisfying the description given.

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

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.

Public Attributes
const	PARAM_SUBMODULE_MAP = 'param-submodule-map'
	(string[]) Map parameter values to submodule paths.

const	PARAM_SUBMODULE_PARAM_PREFIX = 'param-submodule-param-prefix'
	(string) Used to indicate the 'g' prefix added by ApiQueryGeneratorBase (and similar if anything else ever does that).

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'

Protected Member Functions

getEnumValuesForHelp ( $name, array $settings, array $options)

Return enum values formatted for the help message.

Parameters

string	$name	Parameter name being described.
array	$settings	Parameter settings array.
array	$options	Options array.

Returns: (MessageParam|string)[]

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.

Additional Inherited Members
Protected Attributes inherited from Wikimedia\ParamValidator\TypeDef
Callbacks	$callbacks

Detailed Description

Type definition for submodule types.

A submodule type is an enum type for selecting Action API submodules.

Since: 1.35

Definition at line 17 of file SubmoduleDef.php.

Member Function Documentation

◆ checkSettings()

MediaWiki\Api\Validator\SubmoduleDef::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.

See also: ParamValidator::checkSettings()

Stability: stable: to override

Parameters

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	'issues': (string[]) Errors detected in $settings, as English text. If the settings are valid, this will be the empty array. Keys on input are ParamValidator constants, allowing the typedef to easily override core validation; this need not be preserved when returned. 'allowedKeys': (string[]) ParamValidator keys that are allowed in `$settings`. 'messages': (MessageValue[]) Messages to be checked for existence.

Returns: array $ret, with any relevant changes.

Reimplemented from Wikimedia\ParamValidator\TypeDef\EnumDef.

Definition at line 34 of file SubmoduleDef.php.

References MediaWiki\Api\Validator\SubmoduleDef\PARAM_SUBMODULE_MAP.

◆ getEnumValues()

MediaWiki\Api\Validator\SubmoduleDef::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 78 of file SubmoduleDef.php.

◆ getEnumValuesForHelp()

MediaWiki\Api\Validator\SubmoduleDef::getEnumValuesForHelp	(		$name,
		array	$settings,
		array	$options )

protected

Return enum values formatted for the help message.

Parameters

string	$name	Parameter name being described.
array	$settings	Parameter settings array.
array	$options	Options array.

Returns: (MessageParam|string)[]

Reimplemented from Wikimedia\ParamValidator\TypeDef\EnumDef.

Definition at line 185 of file SubmoduleDef.php.

◆ getParamInfo()

MediaWiki\Api\Validator\SubmoduleDef::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.

Stability: stable: to override

Parameters

string	$name	Parameter name.
array	$settings	Parameter settings array.
array	$options	Options array.

Returns: array

Reimplemented from Wikimedia\ParamValidator\TypeDef\EnumDef.

Definition at line 89 of file SubmoduleDef.php.

◆ sortEnumValues()

MediaWiki\Api\Validator\SubmoduleDef::sortEnumValues	(	string	$name,
		array	$values,
		array	$settings,
		array	$options )

protected

Sort enum values for help/param info output.

Parameters

string	$name	Parameter name being described.
string[]	$values	Values being sorted
array	$settings	Parameter settings array.
array	$options	Options array.

Returns: string[]

Reimplemented from Wikimedia\ParamValidator\TypeDef\EnumDef.

Definition at line 157 of file SubmoduleDef.php.

Member Data Documentation

◆ PARAM_SUBMODULE_MAP

const MediaWiki\Api\Validator\SubmoduleDef::PARAM_SUBMODULE_MAP = 'param-submodule-map'

(string[]) Map parameter values to submodule paths.

Default is to use all modules in $options['module']->getModuleManager() in the group matching the parameter name.

Definition at line 25 of file SubmoduleDef.php.

Referenced by MediaWiki\Api\Validator\SubmoduleDef\checkSettings().

◆ PARAM_SUBMODULE_PARAM_PREFIX

const MediaWiki\Api\Validator\SubmoduleDef::PARAM_SUBMODULE_PARAM_PREFIX = 'param-submodule-param-prefix'

(string) Used to indicate the 'g' prefix added by ApiQueryGeneratorBase (and similar if anything else ever does that).

Definition at line 31 of file SubmoduleDef.php.

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

includes/Api/Validator/SubmoduleDef.php

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ checkSettings()

◆ getEnumValues()

◆ getEnumValuesForHelp()

◆ getParamInfo()

◆ sortEnumValues()

Member Data Documentation

◆ PARAM_SUBMODULE_MAP

◆ PARAM_SUBMODULE_PARAM_PREFIX