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

Checks a value for only alpha-numeric content. More...

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

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

Public Member Functions

 ValidatorAlphaNum (const QString &field, bool asciiOnly=false, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString())
 Constructs a new alpha num validator. More...
 
 ~ValidatorAlphaNum ()
 Deconstructs the alpha num 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.
 

Static Public Member Functions

static bool validate (const QString &value, bool asciiOnly=false)
 Returns true if value only contains alpha-numeric characters. More...
 

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 is only allowed to contain alpha-numeric characters. If asciiOnly is set to true, only US-ASCII characters are allowed, otherwise all UTF-8 alpha-numeric characters are allowed.

Note
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.
Examples
"Hallo Kuddel!" // invalid
"HalloKöddel2" // valid if asciiOnly is false
" " // valid if trimBefore is true, invaid if trimBefore is false
See also
Validator for general usage of validators.
ValidatorAlpha, ValidatorAlphaDash

Definition at line 53 of file validatoralphanum.h.

Constructor & Destructor Documentation

◆ ValidatorAlphaNum()

ValidatorAlphaNum::ValidatorAlphaNum ( const QString &  field,
bool  asciiOnly = false,
const ValidatorMessages messages = ValidatorMessages(),
const QString &  defValKey = QString() 
)
Parameters
fieldName of the input field to validate.
asciiOnlyIf true, only ASCII characters are allowed.
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 24 of file validatoralphanum.cpp.

Member Function Documentation

◆ validate()

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