Cutelyst::ValidatorDigits Class Reference

Checks for digits only with optional length check. More...

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

Inheritance diagram for Cutelyst::ValidatorDigits:

Public Member Functions
	ValidatorDigits (const QString &field, const QVariant &length=-1, const ValidatorMessages &messages={}, const QString &defValKey={})
	~ValidatorDigits () 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, qsizetype length=-1)
	Returns true if value only contains digits.

Protected Member Functions
QString	genericValidationError (Context *c, const QVariant &errorData=QVariant()) const override
ValidatorReturnType	validate (Context *c, const ParamsMultiMap &params) const override
void	validateCb (Context *c, const ParamsMultiMap &params, ValidatorRtFn cb) const override
Protected Member Functions inherited from Cutelyst::ValidatorRule
	ValidatorRule (ValidatorRulePrivate &dd)
QString	debugString (const Context *c) const
void	defaultValue (Context *c, ValidatorReturnType *result) const
void	defaultValue (Context *c, ValidatorRtFn cb) 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 (const 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

Additional Inherited Members
Related Symbols inherited from Cutelyst::ValidatorRule
using	ValidatorRtFn = std::function< void(ValidatorReturnType &&result)>
	Void callback function for validator rules that processes the ValidatorReturnType.

Detailed Description

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. The length can be either specified as fixed value or as a QString naming a stash key that contains the length value.

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.

ValidatorDigitsBetween

Definition at line 39 of file validatordigits.h.

Constructor & Destructor Documentation

ValidatorDigits()

ValidatorDigits::ValidatorDigits ( const QString &  field, const QVariant &  length = -1, const ValidatorMessages &  messages = {}, const QString &  defValKey = {}  )

explicit

Constructs a new ValidatorDigits with the given parameters.

Parameters

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 a 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 10 of file validatordigits.cpp.

~ValidatorDigits()

ValidatorDigits::~ValidatorDigits ( )

overridedefault

Destroys the ValidatorDigits object.

Member Function Documentation

genericValidationError()

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

overrideprotectedvirtual

Returns a generic error if validation failed.

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 71 of file validatordigits.cpp.

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

validate()

ValidatorReturnType ValidatorDigits::validate ( Context *  c, const ParamsMultiMap &  params  ) const

overrideprotectedvirtual

Performs the validation on the input params and returns the result.

If validation succeeded, ValidatorReturnType::value will contain the input parameter value as QString.

Implements Cutelyst::ValidatorRule.

Definition at line 20 of file validatordigits.cpp.

References Cutelyst::ValidatorRule::debugString(), Cutelyst::ValidatorRule::defaultValue(), Cutelyst::ValidatorReturnType::errorMessage, QString::isEmpty(), QString::length(), QVariant::setValue(), validate(), Cutelyst::ValidatorRule::validationDataError(), Cutelyst::ValidatorRule::validationError(), Cutelyst::ValidatorReturnType::value, and Cutelyst::ValidatorRule::value().

validateCb()

void ValidatorDigits::validateCb ( Context *  c, const ParamsMultiMap &  params, ValidatorRtFn  cb  ) const

overrideprotectedvirtual

Performs the validation on the input params and calls the cb with the ValidatorReturnType as argument.

If validation succeeded, ValidatorReturnType::value will contain the input parameter value as QString.

Since

Cutelyst 5.0.0

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 59 of file validatordigits.cpp.

References validate().