<Cutelyst/Plugins/Utils/validatordigitsbetween.h> More...

#include <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())
	Constructs a new digits between validator.
	~ValidatorDigitsBetween () override
	Deconstructs the digits between 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.
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
	Returns a generic error if validation failed.
ValidatorReturnType	validate (Context *c, const ParamsMultiMap &params) const override
	Performs the validation and returns the result.
Protected Member Functions inherited from Cutelyst::ValidatorRule
	ValidatorRule (ValidatorRulePrivate &dd)
	Constructs a new ValidatorRule object with the given private class.
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.
QString	field () const
	Returns the name of the field to validate.
virtual QString	genericParsingError (Context *c, const QVariant &errorData=QVariant()) const
	Returns a generic error message if an error occures while parsing input.
virtual QString	genericValidationDataError (Context *c, const QVariant &errorData=QVariant()) const
	Returns a generic error message if any validation data is missing or invalid.
QString	label (Context *c) const
	Returns the human readable field label used for generic error messages.
QString	parsingError (Context *c, const QVariant &errorData=QVariant()) const
	Returns an error message if an error occurred while parsing input.
bool	trimBefore () const
	Returns true if the field value should be trimmed before validation.
QString	validationDataError (Context *c, const QVariant &errorData=QVariant()) const
	Returns an error message if any validation data is missing or invalid.
QString	validationError (Context *c, const QVariant &errorData=QVariant()) const
	Returns a descriptive error message if validation failed.
QString	value (const ParamsMultiMap &params) const
	Returns the value of the field from the input params.

Detailed Description

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

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.

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() )

Parameters

field	Name of the input field to validate.
min	Minimum 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.
max	Maximum 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.
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.