Cutelyst  2.13.0
Public Member Functions | Protected Member Functions | List of all members
Cutelyst::ValidatorRequired Class Reference

Checks if a field is available and not empty. More...

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

Inheritance diagram for Cutelyst::ValidatorRequired:
Inheritance graph

Public Member Functions

 ValidatorRequired (const QString &field, const ValidatorMessages &messages=ValidatorMessages())
 Constructs a new required validator. More...
 ~ValidatorRequired () override
 Deconstructs the required 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 genericValidationError (Context *c, const QVariant &errorData=QVariant()) const override
 Returns a generic error message.
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

The field under validation must be present in the input data and not empty.

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

Definition at line 43 of file validatorrequired.h.

Constructor & Destructor Documentation

◆ ValidatorRequired()

ValidatorRequired::ValidatorRequired ( const QString &  field,
const ValidatorMessages messages = ValidatorMessages() 
fieldName of the input field that is required.
messagesCustom error message if validation fails.

Definition at line 23 of file validatorrequired.cpp.

Member Function Documentation

◆ validate()

ValidatorReturnType ValidatorRequired::validate ( Cutelyst::Context c,
const ParamsMultiMap params 
) const