MediaWiki master
|
Type definition for user types. More...
Inherits Wikimedia\ParamValidator\TypeDef.
Public Member Functions | |
__construct (Callbacks $callbacks, UserIdentityLookup $userIdentityLookup, TitleParser $titleParser, UserNameUtils $userNameUtils) | |
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. | |
normalizeSettings (array $settings) | |
Normalize a settings array. | |
validate ( $name, $value, array $settings, array $options) | |
Validate the value. | |
![]() | |
__construct (Callbacks $callbacks) | |
getEnumValues ( $name, array $settings, array $options) | |
Get the values for enum-like parameters. | |
getValue ( $name, array $settings, array $options) | |
Get the value from the request. | |
stringifyValue ( $name, $value, array $settings, array $options) | |
Convert a value to a string representation. | |
supportsArrays () | |
Whether the value may be an array. | |
Public Attributes | |
const | PARAM_ALLOWED_USER_TYPES = 'param-allowed-user-types' |
(string[]) Allowed types of user. | |
const | PARAM_RETURN_OBJECT = 'param-return-object' |
(bool) Whether to return a UserIdentity object. | |
![]() | |
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 | |
![]() | |
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. | |
![]() | |
Callbacks | $callbacks |
Type definition for user types.
Failure codes:
Definition at line 27 of file UserDef.php.
MediaWiki\ParamValidator\TypeDef\UserDef::__construct | ( | Callbacks | $callbacks, |
UserIdentityLookup | $userIdentityLookup, | ||
TitleParser | $titleParser, | ||
UserNameUtils | $userNameUtils ) |
Callbacks | $callbacks | |
UserIdentityLookup | $userIdentityLookup | |
TitleParser | $titleParser | |
UserNameUtils | $userNameUtils |
Definition at line 74 of file UserDef.php.
References Wikimedia\ParamValidator\TypeDef\$callbacks.
MediaWiki\ParamValidator\TypeDef\UserDef::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.
Definition at line 113 of file UserDef.php.
MediaWiki\ParamValidator\TypeDef\UserDef::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.
string | $name | Parameter name being described. |
array | $settings | Parameter settings array. |
array | $options | Options array. |
Reimplemented from Wikimedia\ParamValidator\TypeDef.
Definition at line 290 of file UserDef.php.
MediaWiki\ParamValidator\TypeDef\UserDef::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.
Definition at line 282 of file UserDef.php.
MediaWiki\ParamValidator\TypeDef\UserDef::normalizeSettings | ( | array | $settings | ) |
Normalize a settings array.
array | $settings |
Reimplemented from Wikimedia\ParamValidator\TypeDef.
Definition at line 99 of file UserDef.php.
References MediaWiki\ParamValidator\TypeDef\UserDef\PARAM_ALLOWED_USER_TYPES.
MediaWiki\ParamValidator\TypeDef\UserDef::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.
Definition at line 86 of file UserDef.php.
References Wikimedia\ParamValidator\TypeDef\failIfNotString(), and Wikimedia\ParamValidator\TypeDef\failure().
const MediaWiki\ParamValidator\TypeDef\UserDef::PARAM_ALLOWED_USER_TYPES = 'param-allowed-user-types' |
(string[]) Allowed types of user.
One or more of the following values:
Default is ‘[ 'name’, 'ip', 'temp', 'cidr', 'interwiki' ]`.
Avoid combining 'id' with PARAM_ISMULTI, as it may result in excessive DB lookups. If you do combine them, consider setting low values for PARAM_ISMULTI_LIMIT1 and PARAM_ISMULTI_LIMIT2 to mitigate it.
Definition at line 46 of file UserDef.php.
Referenced by MediaWiki\ParamValidator\TypeDef\UserDef\normalizeSettings().
const MediaWiki\ParamValidator\TypeDef\UserDef::PARAM_RETURN_OBJECT = 'param-return-object' |
(bool) Whether to return a UserIdentity object.
If false, the validated user name is returned as a string. Default is false.
Avoid setting true with PARAM_ISMULTI, as it may result in excessive DB lookups. If you do combine them, consider setting low values for PARAM_ISMULTI_LIMIT1 and PARAM_ISMULTI_LIMIT2 to mitigate it.
Definition at line 57 of file UserDef.php.