The field under validation must be present in input data but can be empty. More...

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

Inheritance diagram for Cutelyst::ValidatorPresent:

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

	~ValidatorPresent () 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

This validator checks if the field is present in the input data, but not if it contains any content. If you want to check the fields presence and require it to have content, use one of the required validators .

Return type: On success, ValidatorReturnType::value will contain a QString.

See also: Validator for general usage of validators.; ValidatorFilled, ValidatorRequired

Definition at line 30 of file validatorpresent.h.

Constructor & Destructor Documentation

◆ ValidatorPresent()

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

Constructs a new ValidatorPresent 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 validatorpresent.cpp.

◆ ~ValidatorPresent()

ValidatorPresent::~ValidatorPresent ( )

overridedefault

Destroys the ValidatorPresent object.

Member Function Documentation

◆ genericValidationError()

QString ValidatorPresent::genericValidationError	(	Context *	c,
		const QVariant &	errorData = `QVariant()`
	)		const

overrideprotectedvirtual

Returns a generic error message if validation failed.

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 32 of file validatorpresent.cpp.

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

◆ validate()

ValidatorReturnType ValidatorPresent::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 paramter value as QString.

Implements Cutelyst::ValidatorRule.

Definition at line 18 of file validatorpresent.cpp.

References QMultiMap::contains(), Cutelyst::ValidatorRule::debugString(), Cutelyst::ValidatorReturnType::errorMessage, Cutelyst::ValidatorRule::field(), QVariant::setValue(), Cutelyst::ValidatorRule::validationError(), Cutelyst::ValidatorReturnType::value, and Cutelyst::ValidatorRule::value().

Public Member Functions