cutelyst  4.4.0
A C++ Web Framework built on top of Qt, using the simple approach of Catalyst (Perl) framework.
Cutelyst::ValidatorRegularExpression Class Reference

The field under validation must match the given regular expression. More...

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

Inheritance diagram for Cutelyst::ValidatorRegularExpression:

Public Member Functions

 ValidatorRegularExpression (const QString &field, const QRegularExpression &regex, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString())
 
 ~ValidatorRegularExpression () override
 
- Public Member Functions inherited from Cutelyst::ValidatorRule
 ValidatorRule (const QString &field, const ValidatorMessages &messages={}, const QString &defValKey={}, QByteArrayView validatorName=nullptr)
 
virtual ~ValidatorRule ()
 Deconstructs the ValidatorRule.
 

Protected Member Functions

QString genericValidationError (Context *c, const QVariant &errorData=QVariant()) const override
 
ValidatorReturnType validate (Context *c, const ParamsMultiMap &params) const override
 
- Protected Member Functions inherited from Cutelyst::ValidatorRule
 ValidatorRule (ValidatorRulePrivate &dd)
 
QString debugString (Context *c) const
 
void defaultValue (Context *c, ValidatorReturnType *result) const
 
QString field () const noexcept
 
virtual QString genericParsingError (Context *c, const QVariant &errorData={}) const
 
virtual QString genericValidationDataError (Context *c, const QVariant &errorData={}) const
 
QString label (Context *c) const
 
QString parsingError (Context *c, const QVariant &errorData={}) const
 
bool trimBefore () const noexcept
 
QString validationDataError (Context *c, const QVariant &errorData={}) const
 
QString validationError (Context *c, const QVariant &errorData={}) const
 
QString value (const ParamsMultiMap &params) const
 

Detailed Description

Checks if the regex matches the content of the field.

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.
Return type
On success, ValidatorReturnType::value will contain a QString.
See also
Validator for general usage of validators.
ValidatorCharNotAllowed

Definition at line 37 of file validatorregularexpression.h.

Constructor & Destructor Documentation

◆ ValidatorRegularExpression()

ValidatorRegularExpression::ValidatorRegularExpression ( const QString field,
const QRegularExpression regex,
const ValidatorMessages messages = ValidatorMessages(),
const QString defValKey = QString() 
)

Constructs a new ValidatorRegularExpression object.

Parameters
fieldName of the input field to validate.
regexThe regular expression to check against.
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 10 of file validatorregularexpression.cpp.

◆ ~ValidatorRegularExpression()

ValidatorRegularExpression::~ValidatorRegularExpression ( )
overridedefault

Destroys the ValidatorRegularExpresseion object.

Member Function Documentation

◆ genericValidationError()

QString ValidatorRegularExpression::genericValidationError ( Context c,
const QVariant errorData = QVariant() 
) const
overrideprotectedvirtual

Returns a generic error message if validation failed.

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 50 of file validatorregularexpression.cpp.

References QString::arg(), QString::isEmpty(), Cutelyst::ValidatorRule::label(), and Cutelyst::Context::qtTrId().

◆ validate()

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