Cutelyst  2.5.0
Public Member Functions | Protected Member Functions | List of all members
Cutelyst::ValidatorRequiredUnlessStash Class Reference

The field under validation must be present and not emptly unless the content of a stash key is equal to a value in a list. More...

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

Inheritance diagram for Cutelyst::ValidatorRequiredUnlessStash:
Inheritance graph
[legend]

Public Member Functions

 ValidatorRequiredUnlessStash (const QString &field, const QString &stashKey, const QVariantList &stashValues, const ValidatorMessages &messages=ValidatorMessages())
 Constructs a new required unless stash validator. More...
 
 ~ValidatorRequiredUnlessStash ()
 Deconstructs the required unless stash 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...
 
 ~ValidatorRule ()
 Deconstructs the ValidatorRule.
 

Protected Member Functions

QString genericValidationError (Context *c, const QVariant &errorData=QVariant()) const override
 Returns a generic error message if validation failed.
 
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...
 
virtual QString genericParsingError (Context *c, const QVariant &errorData=QVariant()) const
 Returns a generic error message if an error occures while parsing input. More...
 
virtual QString genericValidationDataError (Context *c, const QVariant &errorData=QVariant()) const
 Returns a generic error message if any validation data is missing or invalid. 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

If the stash content identified by stashKey does not contain any of the values specified in the stashValues list, the field under validation must be present and not empty. This validator ist the opposite of ValidatorRequiredIfStash and is similar to ValidatorRequiredUnless.

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.
See also
Validator for general usage of validators.
ValidatorRequired, ValidatorRequiredIf, ValidatorRequiredUnless, ValidatorRequiredWith, ValidatorRequiredWithAll, ValidatorRequiredWithout, ValidatorRequiredWithoutAll, ValidatorRequiredIfStash

Definition at line 47 of file validatorrequiredunlessstash.h.

Constructor & Destructor Documentation

◆ ValidatorRequiredUnlessStash()

ValidatorRequiredUnlessStash::ValidatorRequiredUnlessStash ( const QString &  field,
const QString &  stashKey,
const QVariantList &  stashValues,
const ValidatorMessages messages = ValidatorMessages() 
)
Parameters
fieldName of the input field to validate.
stashKeyName of the stash key to compare against.
stashValuesValues in the stashKey from which no one must match the content of the stash key to require the field.
messagesCustom error messages if validation fails.

Definition at line 23 of file validatorrequiredunlessstash.cpp.

Member Function Documentation

◆ validate()

ValidatorReturnType ValidatorRequiredUnlessStash::validate ( Context c,
const ParamsMultiMap params 
) const
overrideprotectedvirtual