Cutelyst::ValidatorIn Class Reference

Checks if the field value is one from a list of values. More...

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

Inheritance diagram for Cutelyst::ValidatorIn:

Public Member Functions
	ValidatorIn (const QString &field, const QVariant &values, Qt::CaseSensitivity cs=Qt::CaseSensitive, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString())
	~ValidatorIn () 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	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
virtual QString	genericParsingError (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

Validates if the field contains a value from the list values.

Note

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

See also

Validator for general usage of validators.

ValidatorNotIn

Definition at line 35 of file validatorin.h.

Constructor & Destructor Documentation

ValidatorIn()

ValidatorIn::ValidatorIn	(	const QString &	field,
		const QVariant &	values,
		Qt::CaseSensitivity	cs = Qt::CaseSensitive,
		const ValidatorMessages &	messages = ValidatorMessages(),
		const QString &	defValKey = QString()
	)

Constructs a new ValidatorIn object with the given parameters.

Parameters

field	Name of the input field to validate.
values	List of values to compare against. Can be either a QStringList containing the allowed values or a QString specifing a stash key containing a QStringList with allowed values.
cs	Defines if the comparison should be performed case sensitive or insensitive.
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 validatorin.cpp.

~ValidatorIn()

ValidatorIn::~ValidatorIn ( )

overridedefault

Destroys the ValidatorIn object.

Member Function Documentation

genericValidationDataError()

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

overrideprotectedvirtual

Returns a generic error messages if the list of comparison values is empty.

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 75 of file validatorin.cpp.

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

genericValidationError()

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

overrideprotectedvirtual

Returns a generic error message if validation failed.

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 58 of file validatorin.cpp.

References QString::arg(), QLocale::createSeparatedList(), QString::isEmpty(), Cutelyst::ValidatorRule::label(), Cutelyst::Context::locale(), Cutelyst::Context::qtTrId(), and QVariant::toStringList().

validate()

ValidatorReturnType ValidatorIn::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 QString.

Implements Cutelyst::ValidatorRule.

Definition at line 21 of file validatorin.cpp.

References QStringList::contains(), Cutelyst::ValidatorRule::debugString(), Cutelyst::ValidatorRule::defaultValue(), QList::empty(), Cutelyst::ValidatorReturnType::errorMessage, QString::isEmpty(), QMetaType::QString, QMetaType::QStringList, QVariant::setValue(), Cutelyst::Context::stash(), Cutelyst::ValidatorRule::validationDataError(), Cutelyst::ValidatorRule::validationError(), Cutelyst::ValidatorReturnType::value, and Cutelyst::ValidatorRule::value().