Cutelyst
2.13.0
|
Checks for digits only with optional length check. More...
#include <Cutelyst/Plugins/Utils/validatordigits.h>
Public Member Functions | |
ValidatorDigits (const QString &field, const QVariant &length=-1, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString()) | |
Constructs a new digits validator. More... | |
~ValidatorDigits () override | |
Deconstructs the digits 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, int length=-1) |
Returns true if value only contains digits. More... | |
Protected Member Functions | |
QString | genericValidationError (Context *c, const QVariant &errorData=QVariant()) const override |
Returns a generic error if validation failed. More... | |
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 only contain digits with an optional exact length. If length is set to a value lower or equal to 0
, the length check will not be performed. The input digits will not be interpreted as numeric values but as a string. So the length is not meant to test for an exact numeric value but for the string length.
Definition at line 47 of file validatordigits.h.
ValidatorDigits::ValidatorDigits | ( | const QString & | field, |
const QVariant & | length = -1 , |
||
const ValidatorMessages & | messages = ValidatorMessages() , |
||
const QString & | defValKey = QString() |
||
) |
field | Name of the input field to validate. |
length | Exact length of the digits, defaults to -1 . A value lower 1 disables the length check. Should be either an int to directly specify the length or the name of an input field or Stash key containing the length constraint. |
messages | Custom error messages if validation fails. |
defValKey | Stash key containing a default value if input field is empty. This value will NOT be validated. |
Definition at line 23 of file validatordigits.cpp.
|
overrideprotectedvirtual |
errorData will contain 0
, if length is greater than 0
and does not match the field value length, errorData will contain 1
.
Reimplemented from Cutelyst::ValidatorRule.
Definition at line 86 of file validatordigits.cpp.
References Cutelyst::ValidatorRule::label(), and Cutelyst::Context::translate().
|
overrideprotectedvirtual |
If validation succeeded, ValidatorReturnType::value will contain the input parameter value as QString.
Implements Cutelyst::ValidatorRule.
Definition at line 32 of file validatordigits.cpp.
References Cutelyst::ValidatorRule::defaultValue(), Cutelyst::ValidatorReturnType::errorMessage, Cutelyst::ValidatorRule::field(), validate(), Cutelyst::ValidatorRule::validationDataError(), Cutelyst::ValidatorRule::validationError(), Cutelyst::ValidatorReturnType::value, and Cutelyst::ValidatorRule::value().