Checks if the field under validation could be casted into a numeric value. More...

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

Inheritance diagram for Cutelyst::ValidatorNumeric:

Public Member Functions
	ValidatorNumeric (const QString &field, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString())

	~ValidatorNumeric () 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.

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

Checks for signed and unsigned integers as well as floats (also with exponential e) together with minus signs in the input field. Valid values are in format 3, -3.54, 8.89234e12 etc. Internally this will simply try to convert the parameter value from a QString into a double.

Note: Conversion of numeric input values is performed in the 'C' locale.; 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 double.

See also: Validator for general usage of validators.; ValidatorInteger

Definition at line 41 of file validatornumeric.h.

Constructor & Destructor Documentation

◆ ValidatorNumeric()

ValidatorNumeric::ValidatorNumeric	(	const QString &	field,
		const ValidatorMessages &	messages = `ValidatorMessages()`,
		const QString &	defValKey = `QString()`
	)

Constructs a new ValidatorNumeric with the given parameters.

Parameters

field	Name of the input field to validate.
messages	Custom error message 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 validatornumeric.cpp.

◆ ~ValidatorNumeric()

ValidatorNumeric::~ValidatorNumeric ( )

overridedefault

Destroys the ValidatorNumeric object.

Member Function Documentation

◆ genericValidationError()

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

overrideprotectedvirtual

Returns a generic error message if validation failed.

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 43 of file validatornumeric.cpp.

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

◆ validate()

ValidatorReturnType ValidatorNumeric::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 paramter value converted into a double.

Implements Cutelyst::ValidatorRule.

Definition at line 19 of file validatornumeric.cpp.

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

Public Member Functions