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

The field under validation must be present in input data but can be empty. More...

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

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

Public Member Functions

 ValidatorPresent (const QString &field, const ValidatorMessages &messages=ValidatorMessages())
 Constructs a new present validator. More...
 
 ~ValidatorPresent ()
 Deconstructs the present 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

This validator checks if the field is present in the input data, but not if it contains any content. If you want to check the fields presence and require it to have content, use one of the required validators .

See also
Validator for general usage of validators.
ValidatorFilled, ValidatorRequired

Definition at line 40 of file validatorpresent.h.

Constructor & Destructor Documentation

◆ ValidatorPresent()

ValidatorPresent::ValidatorPresent ( const QString &  field,
const ValidatorMessages messages = ValidatorMessages() 
)
Parameters
fieldName of the input field to validate.
messagesCustom error message if validation fails.

Definition at line 23 of file validatorpresent.cpp.

Member Function Documentation

◆ validate()

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