The field under validation must be present and not empty only if any of the other specified fields is present. More...

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

Inheritance diagram for Cutelyst::ValidatorRequiredWith:

Public Member Functions
	ValidatorRequiredWith (const QString &field, const QStringList &otherFields, const ValidatorMessages &messages=ValidatorMessages())

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

If any of the fields defined in the otherFields list is present in the input data, the field under validation must be present and not empty. For the other fields only their presence in the input data will be checked, not their content.

Note: Unless validation is started with NoTrimming, whitespaces will be removed from the beginning and the end of the input value before validation. So, fields that only contain whitespaces will be treated as empty.

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

See also: Validator for general usage of validators.; ValidatorRequired, ValidatorRequiredIf, ValidatorRequiredUnless, ValidatorRequiredWithAll, ValidatorRequiredWithout, ValidatorRequiredWithoutAll

Definition at line 39 of file validatorrequiredwith.h.

Constructor & Destructor Documentation

◆ ValidatorRequiredWith()

ValidatorRequiredWith::ValidatorRequiredWith	(	const QString &	field,
		const QStringList &	otherFields,
		const ValidatorMessages &	messages = `ValidatorMessages()`
	)

Constructs a new ValidatorRequiredWith with the given parameters.

Parameters

field	Name of the input field to validate.
otherFields	List of other fields from which one must be present in the input data to require the field.
messages	Custom error messages if validation fails.

Definition at line 10 of file validatorrequiredwith.cpp.

◆ ~ValidatorRequiredWith()

ValidatorRequiredWith::~ValidatorRequiredWith ( )

overridedefault

Destroys the ValidatorRequiredWith object.

Member Function Documentation

◆ genericValidationError()

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

overrideprotectedvirtual

Returns a generic error message if validation failed.

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 62 of file validatorrequiredwith.cpp.

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

◆ validate()

ValidatorReturnType ValidatorRequiredWith::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 19 of file validatorrequiredwith.cpp.

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

Public Member Functions