Checks for a confirmation input field. More...

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

Inheritance diagram for Cutelyst::ValidatorConfirmed:

Public Member Functions
	ValidatorConfirmed (const QString &field, const ValidatorMessages &messages=ValidatorMessages())

	~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

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

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 39 of file validatorconfirmed.h.

Constructor & Destructor Documentation

◆ ValidatorConfirmed()

ValidatorConfirmed::ValidatorConfirmed	(	const QString &	field,
		const ValidatorMessages &	messages = `ValidatorMessages()`
	)

Constructs a new ValidatorConfirmed object with the given parameters.

Parameters

field	Name of the input field to validate.
messages	Custom 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 44 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().

Public Member Functions