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

Checks for digits only with a length between min and max. More...

#include <validatordigitsbetween.h>

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

Public Member Functions

 ValidatorDigitsBetween (const QString &field, int min, int max, const QString &label=QString(), const QString &customError=QString())
 Constructs a new digits between validator. More...
 
 ~ValidatorDigitsBetween ()
 Deconstructs the digits between validator.
 
void setMax (int max)
 Sets the maximum length.
 
void setMin (int min)
 Sets the minimum length.
 
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

 ValidatorDigitsBetween (ValidatorDigitsBetweenPrivate &dd)
 Constructs a new ValidatorDigitsBetween object with the given private class.
 
QString genericValidationError () const override
 Returns 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 only contain digits with a length between min and max. The digits are not interpreteded as a numeric value but as a string, so the min and max values are not a range for a numeric value but for the string length. Both values default to 0 what will disable the range check.

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. If the field's value is empty or if the field is missing in the input data, the validation will succeed without performing the validation itself. Use one of the required validators to require the field to be present and not empty.

See Validator for general usage of validators.

See also
ValidatorDigits

Definition at line 45 of file validatordigitsbetween.h.

Constructor & Destructor Documentation

Cutelyst::ValidatorDigitsBetween::ValidatorDigitsBetween ( const QString &  field,
int  min,
int  max,
const QString &  label = QString(),
const QString &  customError = QString() 
)
Parameters
fieldName of the input field to validate.
minMinimum length of the digits
maxMaximum length of the digits
labelHuman readable input field label, used for generic error messages.
customErrorCustom error message if validation fails.