Checks if the value is an integer. More...

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

Inheritance diagram for Cutelyst::ValidatorInteger:

Public Member Functions
	ValidatorInteger (const QString &field, QMetaType::Type type=QMetaType::ULongLong, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString())

	~ValidatorInteger () 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
	Returns a generic error message if validation failed.

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

Tries to convert the input parameter value into the integer type specified in the constructor. If the input value does not fit into the type, the validation fails.

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 an integer type set in the constructor.

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

Definition at line 40 of file validatorinteger.h.

Constructor & Destructor Documentation

◆ ValidatorInteger()

ValidatorInteger::ValidatorInteger	(	const QString &	field,
		QMetaType::Type	type = `QMetaType::ULongLong`,
		const ValidatorMessages &	messages = `ValidatorMessages()`,
		const QString &	defValKey = `QString()`
	)

Constructs a new ValidatorInteger object with the given parameters.

Parameters

field	Name of the input field to validate.
type	The type the integer value should fit in. Only integer types are supported, everything else will generate a validation data error.
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 validatorinteger.cpp.

◆ ~ValidatorInteger()

ValidatorInteger::~ValidatorInteger ( )

overridedefault

Destroys the ValidatorInteger object.

Member Function Documentation

◆ genericValidationError()

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

overrideprotectedvirtual

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 66 of file validatorinteger.cpp.

References QString::arg(), QMetaType::Char, QMetaType::Int, QString::isEmpty(), Cutelyst::ValidatorRule::label(), Cutelyst::Context::locale(), QMetaType::Long, QMetaType::LongLong, Cutelyst::Context::qtTrId(), QMetaType::Short, QLocale::toString(), QMetaType::UChar, QMetaType::UInt, QMetaType::ULong, QMetaType::ULongLong, and QMetaType::UShort.

◆ validate()

ValidatorReturnType ValidatorInteger::validate	(	Cutelyst::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 as the type set in the constructor.

Implements Cutelyst::ValidatorRule.

Definition at line 20 of file validatorinteger.cpp.

References QMetaType::Char, Cutelyst::ValidatorRule::debugString(), Cutelyst::ValidatorRule::defaultValue(), Cutelyst::ValidatorReturnType::errorMessage, QMetaType::Int, QString::isEmpty(), QVariant::isValid(), QMetaType::Long, QMetaType::LongLong, QMetaType::Short, QMetaType::UChar, QMetaType::UInt, QMetaType::ULong, QMetaType::ULongLong, QMetaType::UShort, Cutelyst::ValidatorRule::validationDataError(), Cutelyst::ValidatorRule::validationError(), Cutelyst::ValidatorReturnType::value, and Cutelyst::ValidatorRule::value().

Public Member Functions