cutelyst 5.0.0
A C++ Web Framework built on top of Qt, using the simple approach of Catalyst (Perl) framework.
Cutelyst::ValidatorNotIn Class Reference

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

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

Inheritance diagram for Cutelyst::ValidatorNotIn:

Public Member Functions

 ValidatorNotIn (const QString &field, const QVariant &values, Qt::CaseSensitivity cs=Qt::CaseSensitive, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey={})
 
 ~ValidatorNotIn () 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
 
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
 
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

Detailed Description

This validator checks if the value of the field is not one from a list of 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.
ValidatorIn

Definition at line 37 of file validatornotin.h.

Constructor & Destructor Documentation

◆ ValidatorNotIn()

ValidatorNotIn::ValidatorNotIn ( const QString field,
const QVariant values,
Qt::CaseSensitivity  cs = Qt::CaseSensitive,
const ValidatorMessages messages = ValidatorMessages(),
const QString defValKey = {} 
)

Constructs a new VaidatorNotIn with the given parameters.

Parameters
fieldName of the input field to validate.
valuesList of values to compare against. Can be either a QStringList containing the not allowed values or a QString specifing a stash key containing a QStringList with not allowed values.
csCase sensitivity when comparing the values.
messagesCustom error message if validation fails.
defValKeyStash key containing a default value if input field is empty. This value will NOT be validated.

Definition at line 10 of file validatornotin.cpp.

◆ ~ValidatorNotIn()

ValidatorNotIn::~ValidatorNotIn ( )
overridedefault

Destroys the ValidatorNotIn object.

Member Function Documentation

◆ genericValidationDataError()

QString ValidatorNotIn::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 77 of file validatornotin.cpp.

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

◆ genericValidationError()

QString ValidatorNotIn::genericValidationError ( Context c,
const QVariant errorData = QVariant() 
) const
overrideprotectedvirtual

Returns a generic error message if validation failed.

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 64 of file validatornotin.cpp.

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

◆ validate()

◆ validateCb()

void ValidatorNotIn::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 as QString.

Since
Cutelyst 5.0.0

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 59 of file validatornotin.cpp.

References validate().