Cutelyst  2.3.0
Public Member Functions | Protected Member Functions | List of all members
Cutelyst::ValidatorBetween Class Reference

Checks if a value or text length is between a minimum and maximum value. More...

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

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

Public Member Functions

 ValidatorBetween (const QString &field, QMetaType::Type type, const QVariant &min, const QVariant &max, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString())
 Constructs a new between validator. More...
 
 ~ValidatorBetween ()
 Deconstructs the between 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 genericParsingError (Context *c, const QVariant &errorData) const override
 Returns a generic error message for input value parsing errors.
 
QString genericValidationDataError (Context *c, const QVariant &errorData) const override
 Returns a generic error message for validation data errors.
 
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...
 
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 has the mandatory extra parameters type, min and max. type specifies the type to validate against, it can be either a QMetaType::Type for a number value (Int, UInt, Float, etc.) or QString, that are used as base types. You can compare against any integer, floating point or string type. If you validate a string, it's length will be checked if it is between min and max values.

If you set a string to the min and/or max values, this will neither be interpreted as a number nor as string length, but will be used to get the comparison number value from the stash.

Note
Conversion of numeric input values is performed in the 'C' locale.
Unless validation is started with NoTrimming, 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.
Example
Validator v({new ValidatorBetween(QStringLiteral("username"), QMetaType::QString, 3, 255))});
See also
Validator for general usage of validators.
ValidatorMin, ValidatorMax, ValidatorSize

Definition at line 56 of file validatorbetween.h.

Constructor & Destructor Documentation

◆ ValidatorBetween()

ValidatorBetween::ValidatorBetween ( const QString &  field,
QMetaType::Type  type,
const QVariant &  min,
const QVariant &  max,
const ValidatorMessages messages = ValidatorMessages(),
const QString &  defValKey = QString() 
)
Parameters
fieldName of the input field to validate.
typeThe type to compare. Can be either a QMetaType::Type for a number value or QMetaType::QString.
minMinimum value. Will be converted into comparable value. If it is a QString, it will try to get the comparison value from another params field or the stash.
maxMaximum value. Will be converted into comparable value. If it is a QString, it will try to get the comparison value from another params field or the stash.
messagesCustom error message if validation fails.
defValKeyStash key containing a default value if input field is empty. This value will NOT be validated.

Definition at line 23 of file validatorbetween.cpp.

Member Function Documentation

◆ validate()

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