Cutelyst  1.8.0
Public Member Functions | Protected Member Functions | List of all members
Cutelyst::ValidatorAccepted Class Reference

Checks if a field is available and has a specific value. More...

#include <validatoraccepted.h>

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

Public Member Functions

 ValidatorAccepted (const QString &field, const QString &label=QString(), const QString &customError=QString())
 Constructs a new accepted validator. More...
 
 ~ValidatorAccepted ()
 Deconstructs the accepted validator.
 
QString validate () const override
 Performs the validation and returns an empty QString on success, otherwise an error message.
 
- Public Member Functions inherited from Cutelyst::ValidatorRule
 ValidatorRule (const QString &field, const QString &label=QString(), const QString &customError=QString())
 Constructs a new ValidatorRule with given parameters and parent. More...
 
 ~ValidatorRule ()
 Deconstructs the ValidatorRule.
 
QString field () const
 Returns the name of the field to validate. More...
 
QString label () const
 Returns the human readable field label used for generic error messages. More...
 
ParamsMultiMap parameters () const
 Returns the parameters to validate. More...
 
void setCustomError (const QString &customError)
 Sets a cutom error returned with errorMessage() More...
 
void setCustomParsingError (const QString &custom)
 Sets a custom error message that is shown if parsing of input data fails. More...
 
void setCustomValidationDataError (const QString &custom)
 Sets a custom error message if validation data is invalid or missing. More...
 
void setField (const QString &field)
 Sets the name of the field to validate. More...
 
void setLabel (const QString &label)
 Sets human readable field label for generic error messages. More...
 
void setParameters (const ParamsMultiMap &params)
 Sets the request parameters to validate. More...
 
void setTrimBefore (bool trimBefore)
 Set to false to not trim input value before validation. More...
 
bool trimBefore () const
 Returns true if field value should be trimmed before validation. More...
 
QString value () const
 Returns the field value.
 

Protected Member Functions

 ValidatorAccepted (ValidatorAcceptedPrivate &dd)
 Constructs a new ValidatorAccepted object with the given private class.
 
QString genericValidationError () const override
 Creates a generic error message.
 
- Protected Member Functions inherited from Cutelyst::ValidatorRule
 ValidatorRule (ValidatorRulePrivate &dd)
 Constructs a new ValidatorRule object with the given private class.
 
virtual QString genericParsingError () const
 Returns a generic error message if an error occures while parsing input. More...
 
virtual QString genericValidationDataError () const
 Returns a generic error message if any validation data is missing or invalid. More...
 
QString parsingError () const
 Returns an error message if an error occured while parsing input. More...
 
QString validationDataError () const
 Returns an error message if any validation data is missing or invalid. More...
 
QString validationError () const
 Returns a descriptive error message if validation failed. More...
 

Detailed Description

The field under validation must be yes, on, 1, or true. This is useful for validating "Terms of Service" acceptance. This check will also fail if the input data for the specified field is empty or if the field is not part of the input data.

If ValidatorRule::trimBefore() is set to true (the default), whitespaces will be removed from the beginning and the end of the input value before validation.

See Validator for general usage of validators.

Definition at line 40 of file validatoraccepted.h.

Constructor & Destructor Documentation

Cutelyst::ValidatorAccepted::ValidatorAccepted ( const QString &  field,
const QString &  label = QString(),
const QString &  customError = QString() 
)
Parameters
fieldName of the input field to validate.
labelHuman readable input field label, used for generic error messages.
customErrorCustom error message if validation fails.