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

The field under validation must be present and not empty only if all of the other specified fields are present. More...

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

Inheritance diagram for Cutelyst::ValidatorRequiredWithAll:

Public Member Functions

 ValidatorRequiredWithAll (const QString &field, const QStringList &otherFields, const ValidatorMessages &messages=ValidatorMessages())
 
 ~ValidatorRequiredWithAll () 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
 
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
 
virtual QString genericValidationError (Context *c, const QVariant &errorData={}) const
 
QString label (Context *c) const
 
QString parsingError (Context *c, const QVariant &errorData={}) const
 
bool trimBefore () const noexcept
 
virtual ValidatorReturnType validate (Context *c, const ParamsMultiMap &params) const =0
 
QString validationDataError (Context *c, const QVariant &errorData={}) const
 
QString validationError (Context *c, const QVariant &errorData={}) const
 
QString value (const ParamsMultiMap &params) const
 

Detailed Description

If all of the fields defined in the otherFields list are present in the input data, the field under validation must be present and not empty. For the other fields only their presence will be checked, not their content.

Note
Unless validation is started with NoTrimming, whitespaces will be removed from the beginning and the end of the input value before validation. So, fields that only contain whitespaces will be treated as empty.
Return type
On success, ValidatorReturnType::value will contain a QString.
See also
Validator for general usage of validators.
ValidatorRequired, ValidatorRequiredIf, ValidatorRequiredUnless, ValidatorRequiredWith, ValidatorRequiredWithout, ValidatorRequiredWithoutAll

Definition at line 39 of file validatorrequiredwithall.h.

Constructor & Destructor Documentation

◆ ValidatorRequiredWithAll()

ValidatorRequiredWithAll::ValidatorRequiredWithAll ( const QString &  field,
const QStringList &  otherFields,
const ValidatorMessages messages = ValidatorMessages() 
)

Constructs a new ValidatorRequiredWithAll object with the given parameters.

Parameters
fieldName of the input field to validate.
otherFieldsList of fields that mus all be present in the input data to require the field.
messagesCustom error messages if validation fails.

Definition at line 10 of file validatorrequiredwithall.cpp.

◆ ~ValidatorRequiredWithAll()

ValidatorRequiredWithAll::~ValidatorRequiredWithAll ( )
overridedefault

Destroys the ValidatorRequiredWithAll object.

Member Function Documentation

◆ genericValidationError()

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

Returns a generic error message if validation failed.

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 63 of file validatorrequiredwithall.cpp.

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

◆ validate()

ValidatorReturnType ValidatorRequiredWithAll::validate ( 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 19 of file validatorrequiredwithall.cpp.

References Cutelyst::ValidatorRule::debugString(), Cutelyst::ValidatorReturnType::errorMessage, Cutelyst::ValidatorRule::validationDataError(), Cutelyst::ValidatorRule::validationError(), Cutelyst::ValidatorReturnType::value, and Cutelyst::ValidatorRule::value().