MediaWiki REL1_35
|
Type definition for boolean types. More...
Public Member Functions | |
getHelpInfo ( $name, array $settings, array $options) | |
Describe parameter settings in human-readable format. | |
stringifyValue ( $name, $value, array $settings, array $options) | |
Convert a value to a string representation. | |
validate ( $name, $value, array $settings, array $options) | |
Validate the value. | |
![]() | |
__construct (Callbacks $callbacks) | |
Stable to call. | |
checkSettings (string $name, $settings, array $options, array $ret) | |
Validate a parameter settings array. | |
getEnumValues ( $name, array $settings, array $options) | |
Get the values for enum-like parameters. | |
getParamInfo ( $name, array $settings, array $options) | |
Describe parameter settings in a machine-readable format. | |
getValue ( $name, array $settings, array $options) | |
Get the value from the request Stable to override. | |
normalizeSettings (array $settings) | |
Normalize a settings array Stable to override. | |
Static Public Attributes | |
static | $FALSEVALS = [ 'false', 'f', 'no', 'n', 'off', '0' ] |
static | $TRUEVALS = [ 'true', 't', 'yes', 'y', 'on', '1' ] |
Private Member Functions | |
quoteVal ( $v) | |
Additional Inherited Members | |
![]() | |
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. | |
![]() | |
Callbacks | $callbacks |
Type definition for boolean types.
This type accepts certain defined strings to mean 'true' or 'false'. The result from validate() is a PHP boolean.
Failure codes:
Definition at line 23 of file BooleanDef.php.
Wikimedia\ParamValidator\TypeDef\BooleanDef::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. Stable to override
string | $name | Parameter name being described. |
array | $settings | Parameter settings array. |
array | $options | Options array. |
Reimplemented from Wikimedia\ParamValidator\TypeDef.
Definition at line 58 of file BooleanDef.php.
References Wikimedia\ParamValidator\ParamValidator\PARAM_ISMULTI, and Wikimedia\ParamValidator\ParamValidator\PARAM_TYPE.
|
private |
Definition at line 50 of file BooleanDef.php.
References Wikimedia\Message\ParamType\TEXT.
Wikimedia\ParamValidator\TypeDef\BooleanDef::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().
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. |
Reimplemented from Wikimedia\ParamValidator\TypeDef.
Definition at line 54 of file BooleanDef.php.
Wikimedia\ParamValidator\TypeDef\BooleanDef::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 28 of file BooleanDef.php.
References Wikimedia\ParamValidator\TypeDef\failure(), and Wikimedia\ParamValidator\TypeDef\failureMessage().
|
static |
Definition at line 26 of file BooleanDef.php.
|
static |
Definition at line 25 of file BooleanDef.php.