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())
	Constructs a new max validator. More...

	~ValidatorMax () override
	Deconstructs the max 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. More...

virtual	~ValidatorRule ()
	Deconstructs the ValidatorRule.

Protected Member Functions
QString	genericParsingError (Context *c, const QVariant &errorData) const override
	Returns a generic error message for input value parsing errors.

QString	genericValidationDataError (Context *c, const QVariant &errorData) const override
	Returns a generic error message for validation data errors. More...

QString	genericValidationError (Context *c, const QVariant &errorData=QVariant()) const override
	Returns a generic error message. More...

ValidatorReturnType	validate (Context *c, const ParamsMultiMap &params) const override
	Performs the validation and returns the result. More...

Protected Member Functions inherited from Cutelyst::ValidatorRule
	ValidatorRule (ValidatorRulePrivate &dd)
	Constructs a new ValidatorRule object with the given private class. More...

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. More...

QString	field () const
	Returns the name of the field to validate. More...

QString	label (Context *c) const
	Returns the human readable field label used for generic error messages. More...

QString	parsingError (Context *c, const QVariant &errorData=QVariant()) const
	Returns an error message if an error occured while parsing input. More...

bool	trimBefore () const
	Returns true if the field value should be trimmed before validation. More...

QString	validationDataError (Context *c, const QVariant &errorData=QVariant()) const
	Returns an error message if any validation data is missing or invalid. More...

QString	validationError (Context *c, const QVariant &errorData=QVariant()) const
	Returns a descriptive error message if validation failed. More...

QString	value (const ParamsMultiMap &params) const
	Returns the value of the field from the input params.

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.

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

Definition at line 53 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()`
	)

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.

Definition at line 23 of file validatormax.cpp.

Member Function Documentation

◆ genericValidationDataError()

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

overrideprotectedvirtual

Parameters

c	The current context, used for translations.
errorData	Will contain either 1 if comparison value is invalid or 0 if the type is not supported.

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 225 of file validatormax.cpp.

References Cutelyst::ValidatorRule::field(), Cutelyst::ValidatorRule::label(), and Cutelyst::Context::translate().

◆ genericValidationError()

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

overrideprotectedvirtual

Parameters

c	The current context, used for translations.
errorData	Will contain a QVariantMap with "val" containing the value and "max" containing the comparison value.

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 173 of file validatormax.cpp.

References Cutelyst::ValidatorRule::label(), Cutelyst::Context::locale(), Cutelyst::Context::translate(), and Cutelyst::ValidatorRule::validationDataError().