Cutelyst::ValidatorNumeric Class Reference

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={}, const QString &defValKey={})
	~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
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

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 39 of file validatornumeric.h.

Constructor & Destructor Documentation

ValidatorNumeric()

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

explicit

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

Referenced by validateCb().

validateCb()

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

Since

Cutelyst 5.0.0

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 43 of file validatornumeric.cpp.

References validate().