cutelyst 5.0.1
A C++ Web Framework built on top of Qt, using the simple approach of Catalyst (Perl) framework.
Public Member Functions | Protected Member Functions | List of all members
Cutelyst::ValidatorConfirmed Class Reference
Plugins » Utils » Validator » Rules

Checks for a confirmation input field. More...

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

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

Public Member Functions

 ValidatorConfirmed (const QString &field, const ValidatorMessages &messages={})
 
 ~ValidatorConfirmed () 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
 
void validateCb (Context *c, const ParamsMultiMap &params, ValidatorRtFn cb) const override
 
- Protected Member Functions inherited from Cutelyst::ValidatorRule
 ValidatorRule (ValidatorRulePrivate &dd)
 
QString debugString (const Context *c) const
 
void defaultValue (Context *c, ValidatorReturnType *result) const
 
void defaultValue (Context *c, ValidatorRtFn cb) 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 (const 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
 

Additional Inherited Members

- Related Symbols inherited from Cutelyst::ValidatorRule
 Void callback function for validator rules that processes the ValidatorReturnType.
 

Detailed Description

The field under validation must have a matching field of foo_confirmation. For example, if the field under validation is password, a matching password_confirmation field must be present in the input with the same value.

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.
ValidatorSame

Definition at line 37 of file validatorconfirmed.h.

Constructor & Destructor Documentation

◆ ValidatorConfirmed()

ValidatorConfirmed::ValidatorConfirmed ( const QString &  field,
const ValidatorMessages &  messages = {} 
)
explicit

Constructs a new ValidatorConfirmed object with the given parameters.

Parameters
fieldName of the input field to validate.
messagesCustom error message if validation fails.

Definition at line 10 of file validatorconfirmed.cpp.

◆ ~ValidatorConfirmed()

ValidatorConfirmed::~ValidatorConfirmed ( )
overridedefault

Destroys the ValidatorConfirmed object.

Member Function Documentation

◆ genericValidationError()

QString ValidatorConfirmed::genericValidationError ( Context *  c,
const QVariant &  errorData = QVariant() 
) const
overrideprotectedvirtual

Returns a generic error message if validation failed.

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 51 of file validatorconfirmed.cpp.

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

◆ validate()

ValidatorReturnType ValidatorConfirmed::validate ( Context *  c,
const ParamsMultiMap &  params 
) const
overrideprotectedvirtual

Performs the validation on the input params and returns the result.

If validation succeeded, ValidatorReturnType::value will contain the input paramater values as QString.

Implements Cutelyst::ValidatorRule.

Definition at line 17 of file validatorconfirmed.cpp.

References Cutelyst::ValidatorRule::debugString(), Cutelyst::ValidatorReturnType::errorMessage, Cutelyst::ValidatorRule::field(), QString::isEmpty(), QVariant::setValue(), Cutelyst::ValidatorRule::trimBefore(), QString::trimmed(), Cutelyst::ValidatorRule::validationError(), Cutelyst::ValidatorReturnType::value, QMultiMap::value(), and Cutelyst::ValidatorRule::value().

Referenced by validateCb().

◆ validateCb()

void ValidatorConfirmed::validateCb ( Context *  c,
const ParamsMultiMap &  params,
ValidatorRtFn  cb 
) const
overrideprotectedvirtual

Performs the validation on the input params and calls the cb with the ValidatorReturnType as argument.

If validation succeeded, ValidatorReturnType::value will contain the input paramater values as QString.

Since
Cutelyst 5.0.0

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 44 of file validatorconfirmed.cpp.

References validate().