cutelyst 4.8.0
A C++ Web Framework built on top of Qt, using the simple approach of Catalyst (Perl) framework.
Cutelyst::ValidatorDigitsBetween Class Reference

Checks for digits only with a length between min and max. More...

#include <Cutelyst/Plugins/Utils/validatordigitsbetween.h>

Inheritance diagram for Cutelyst::ValidatorDigitsBetween:

Public Member Functions

 ValidatorDigitsBetween (const QString &field, const QVariant &min, const QVariant &max, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString())
 ~ValidatorDigitsBetween () override
Public Member Functions inherited from Cutelyst::ValidatorRule
 ValidatorRule (const QString &field, const ValidatorMessages &messages={}, const QString &defValKey={}, QByteArrayView validatorName=nullptr)
virtual ~ValidatorRule ()
 Deconstructs the ValidatorRule.

Static Public Member Functions

static bool validate (const QString &value, int min, int max)
 Returns true if value only contains digits and has a length between min and max.

Protected Member Functions

QString genericValidationError (Context *c, const QVariant &errorData=QVariant()) const override
ValidatorReturnType validate (Context *c, const ParamsMultiMap &params) const override
Protected Member Functions inherited from Cutelyst::ValidatorRule
 ValidatorRule (ValidatorRulePrivate &dd)
QString debugString (Context *c) const
void defaultValue (Context *c, ValidatorReturnType *result) const
QString field () const noexcept
virtual QString genericParsingError (Context *c, const QVariant &errorData={}) const
virtual QString genericValidationDataError (Context *c, const QVariant &errorData={}) const
QString label (Context *c) const
QString parsingError (Context *c, const QVariant &errorData={}) const
bool trimBefore () const noexcept
QString validationDataError (Context *c, const QVariant &errorData={}) const
QString validationError (Context *c, const QVariant &errorData={}) const
QString value (const ParamsMultiMap &params) const

Detailed Description

The field under validation must only contain digits with a length between min and max. The digits are not interpreteded as a numeric value but as a string, so the min and max values are not a range for a numeric value but for the string length.

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.
Return type
On success, ValidatorReturnType::value will contain a QString.
See also
Validator for general usage of validators.
ValidatorDigits

Definition at line 37 of file validatordigitsbetween.h.

Constructor & Destructor Documentation

◆ ValidatorDigitsBetween()

ValidatorDigitsBetween::ValidatorDigitsBetween ( const QString & field,
const QVariant & min,
const QVariant & max,
const ValidatorMessages & messages = ValidatorMessages(),
const QString & defValKey = QString() )

Constructs a new ValidatorDigitsBetween with the given parameters.

Parameters
fieldName of the input field to validate.
minMinimum length of the digits. Should either be an integer value to directly specify the length or the name of a Stash key containing the length constraint.
maxMaximum length of the digits. Should either be an integer value to directly specify the length or the name of a Stash key containing the length constraint.
messagesCustom error messages if validation fails.
defValKeyStash key containing a default value if input field is empty. This value will NOT be validated.

Definition at line 10 of file validatordigitsbetween.cpp.

References Cutelyst::ValidatorRule::ValidatorRule(), and Cutelyst::ValidatorRule::field().

Referenced by ~ValidatorDigitsBetween(), and validate().

◆ ~ValidatorDigitsBetween()

ValidatorDigitsBetween::~ValidatorDigitsBetween ( )
overridedefault

Destroys the ValidatorDigitsBetween object.

References ValidatorDigitsBetween(), genericValidationError(), validate(), and Cutelyst::ValidatorRule::value().

Member Function Documentation

◆ genericValidationError()

QString ValidatorDigitsBetween::genericValidationError ( Context * c,
const QVariant & errorData = QVariant() ) const
overrideprotectedvirtual

Returns a generic error if validation failed.

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 88 of file validatordigitsbetween.cpp.

References QString::arg(), QString::at(), QString::isEmpty(), Cutelyst::ValidatorRule::label(), Cutelyst::Context::qtTrId(), and QVariant::toList().

Referenced by ~ValidatorDigitsBetween().

◆ validate()