Checks if a value can be casted into a boolean. More...
#include <Cutelyst/Plugins/Utils/validatorboolean.h>
Inheritance diagram for Cutelyst::ValidatorBoolean:
Public Member Functions | |
| ValidatorBoolean (const QString &field, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString()) | |
| Constructs a new validator. More... | |
| ~ValidatorBoolean () override | |
| Deconstructs the validator. | |
 Public Member Functions inherited from Cutelyst::ValidatorRule | |
| ValidatorRule (const QString &field, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString()) | |
| Constructs a new ValidatorRule with the given parameters. More... | |
| virtual | ~ValidatorRule () |
| Deconstructs the ValidatorRule. | |
Protected Member Functions | |
| QString | genericValidationError (Context *c, const QVariant &errorData=QVariant()) const override |
| Returns a generic error message if validation failed. | |
| ValidatorReturnType | validate (Context *c, const ParamsMultiMap ¶ms) const override |
| Performs the validation and returns the result. More... | |
| Protected Member Functions inherited from Cutelyst::ValidatorRule | |
| ValidatorRule (ValidatorRulePrivate &dd) | |
| Constructs a new ValidatorRule object with the given private class. More... | |
| void | defaultValue (Context *c, ValidatorReturnType *result, const char *validatorName) const |
| I a defValKey has been set in the constructor, this will try to get the default value from the stash and put it into the result. More... | |
| QString | field () const |
| Returns the name of the field to validate. More... | |
| virtual QString | genericParsingError (Context *c, const QVariant &errorData=QVariant()) const |
| Returns a generic error message if an error occures while parsing input. More... | |
| virtual QString | genericValidationDataError (Context *c, const QVariant &errorData=QVariant()) const |
| Returns a generic error message if any validation data is missing or invalid. More... | |
| QString | label (Context *c) const |
| Returns the human readable field label used for generic error messages. More... | |
| QString | parsingError (Context *c, const QVariant &errorData=QVariant()) const |
| Returns an error message if an error occured while parsing input. More... | |
| bool | trimBefore () const |
| Returns true if the field value should be trimmed before validation. More... | |
| QString | validationDataError (Context *c, const QVariant &errorData=QVariant()) const |
| Returns an error message if any validation data is missing or invalid. More... | |
| QString | validationError (Context *c, const QVariant &errorData=QVariant()) const |
| Returns a descriptive error message if validation failed. More... | |
| QString | value (const ParamsMultiMap ¶ms) const |
| Returns the value of the field from the input params. | |
Detailed Description
The field under validation must contain one of the following acceptable input values: 1, 0, true, false, on and off.
- Note
- Unless validation is started with NoTrimming, whitespaces will be removed from the beginning and the end of the input value before validation. If the field's value is empty or if the field is missing in the input data, the validation will succeed without performing the validation itself. Use one of the required validators to require the field to be present and not empty.
- See also
- Validator for general usage of validators.
Definition at line 43 of file validatorboolean.h.
Constructor & Destructor Documentation
◆ ValidatorBoolean()
| ValidatorBoolean::ValidatorBoolean | ( | const QString & | field, |
| const ValidatorMessages & | messages = ValidatorMessages(), |
||
| const QString & | defValKey = QString() |
||
| ) |
- Parameters
-
field Name of the input field to validate. messages Custom error message if validation fails. defValKey Stash key containing a default value if input field is empty. This value will NOT be validated.
Definition at line 24 of file validatorboolean.cpp.
Member Function Documentation
◆ validate()
|
overrideprotectedvirtual |
If validation succeeded, ValidatorReturnType::value will either contain true if the input value contains 1, true or \on, or false if value contains 0, false or off.
Implements Cutelyst::ValidatorRule.
Definition at line 33 of file validatorboolean.cpp.
References Cutelyst::ValidatorRule::defaultValue(), Cutelyst::ValidatorReturnType::errorMessage, Cutelyst::ValidatorRule::field(), Cutelyst::ValidatorRule::validationError(), Cutelyst::ValidatorReturnType::value, and Cutelyst::ValidatorRule::value().
