Checks if a value is not bigger or longer than a maximum value. More...

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

Inheritance diagram for Cutelyst::ValidatorMax:

Public Member Functions
	ValidatorMax (const QString &field, QMetaType::Type type, const QVariant &max, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString())

	~ValidatorMax () 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	genericParsingError (Context *c, const QVariant &errorData) const override

QString	genericValidationDataError (Context *c, const QVariant &errorData) const override

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

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

This works for floating point, integer and QString types, where for numeric types it will check the value itself while for QString it will check the string length. Use max to define the maximum value and type to set the type to check against. max will internally converted into a comparative value (qlonglong for QMetaType::Int, qulonglong for QMetaType::UInt and int for QMetaType::QString. Allowed types for the type specifier are all numeric types and QMetaType::QString. Any other type will result in a validation data error.

If you set a string to the max value, this will neither be interpreted as a number nor as string length, but will be used to get the comparison number value from the stash.

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 the type specified in the constructor.

See also: Validator for general usage of validators.; ValidatorMin, ValidatorSize, ValidatorBetween

Definition at line 46 of file validatormax.h.

Constructor & Destructor Documentation

◆ ValidatorMax()

ValidatorMax::ValidatorMax	(	const QString &	field,
		QMetaType::Type	type,
		const QVariant &	max,
		const ValidatorMessages &	messages = `ValidatorMessages()`,
		const QString &	defValKey = `QString()`
	)

Constructs a new ValidatorMax object with the given parameters.

Parameters

field	Name of the input field to validate.
type	The type to compare.
max	Maximum value. Will be converted into comparable value. If it is a QString, it will try to get the comparison value from the stash.
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.