Cutelyst
2.13.0
|
Checks if a field is available and has a specific value. More...
#include <Cutelyst/Plugins/Utils/validatoraccepted.h>
Public Member Functions | |
ValidatorAccepted (const QString &field, const ValidatorMessages &messages=ValidatorMessages()) | |
Constructs a new accepted validator. More... | |
~ValidatorAccepted () override | |
Deconstructs the accepted validator. | |
![]() | |
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. | |
Static Public Member Functions | |
static bool | validate (const QString &value) |
Returns true if the value is yes , on , 1 , or true . More... | |
Protected Member Functions | |
QString | genericValidationError (Context *c, const QVariant &errorData=QVariant()) const override |
Creates a generic error message. | |
ValidatorReturnType | validate (Context *c, const ParamsMultiMap ¶ms) const override |
Performs the validation and returns the result. More... | |
![]() | |
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. | |
The field under validation must be yes
, on
, 1
, or true
. This is useful for validating "Terms of Service" acceptance. This check will also fail if the input data for the specified field is empty or if the field is not part of the input data.
Definition at line 41 of file validatoraccepted.h.
ValidatorAccepted::ValidatorAccepted | ( | const QString & | field, |
const ValidatorMessages & | messages = ValidatorMessages() |
||
) |
field | Name of the input field to validate. |
messages | Custom error message if validation fails. |
Definition at line 24 of file validatoraccepted.cpp.
|
overrideprotectedvirtual |
If validation succeeded, ValidatorReturnType::value will contain true
.
Implements Cutelyst::ValidatorRule.
Definition at line 35 of file validatoraccepted.cpp.
References Cutelyst::ValidatorReturnType::errorMessage, Cutelyst::ValidatorRule::field(), validate(), Cutelyst::ValidatorRule::validationError(), Cutelyst::ValidatorReturnType::value, and Cutelyst::ValidatorRule::value().