The field under validation must be present and not empty if the content of a stash key is equal to one from a list. More...

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

Inheritance diagram for Cutelyst::ValidatorRequiredIfStash:

[legend]

Public Member Functions
	ValidatorRequiredIfStash (const QString &field, const QString &stashKey, const QVariant &stashValues, const ValidatorMessages &messages=ValidatorMessages())

	~ValidatorRequiredIfStash () 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 the value of the stashKey is equal to one of the values defined in stashValues, the input field under validation must be present and not empty. stashValues can contain a QString, a QStringList or a QVariantList. If it is a QString, it is interpreted as a stash key that contains the comparison list, that has to be either a QStringList or a QVariantList. If stashValues or the content of the there specified stash key is a QStringList, the content of stashKey will be converted into a QString to compare. If stashValues or the content of the there specified stash key is a QVariantList, the variants will be compared.

This validator is the opposite of ValidatorRequiredUnlessStash and is similar to ValidatorRequiredIf.

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, ValidatorRequiredWith, ValidatorRequiredWithAll, ValidatorRequiredWithout, ValidatorRequiredWithoutAll, ValidatorRequiredUnlessStash

Definition at line 48 of file validatorrequiredifstash.h.

Constructor & Destructor Documentation

◆ ValidatorRequiredIfStash()

ValidatorRequiredIfStash::ValidatorRequiredIfStash	(	const QString &	field,
		const QString &	stashKey,
		const QVariant &	stashValues,
		const ValidatorMessages &	messages = `ValidatorMessages()`
	)

Constructs a new ValidatorRequiredIfStash with the given parameters.

Parameters

field	Name of the input field to validate.
stashKey	Name of the stash key to compare against.
stashValues	Can be a QString pointing to a stash key containing a QStringList or a QVariantList, directly a QStringList or directly a QVariantList. The list content must match the content of the stashKey to require the field.
messages	Custom error messages if validation fails.