Cutelyst::ValidatorRequiredIfStash Class Reference

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:

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
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
using	ValidatorRtFn
	Void callback function for validator rules that processes the ValidatorReturnType.

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

Definition at line 10 of file validatorrequiredifstash.cpp.

References Cutelyst::ValidatorRule::ValidatorRule(), and Cutelyst::ValidatorRule::field().

Referenced by ~ValidatorRequiredIfStash(), and validate().

~ValidatorRequiredIfStash()

ValidatorRequiredIfStash::~ValidatorRequiredIfStash ( )

overridedefault

Destroys the ValidatorRequiredIfStash object.

References ValidatorRequiredIfStash(), genericValidationError(), validate(), and validateCb().

Member Function Documentation

genericValidationError()

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

overrideprotectedvirtual

Returns a generic error message if validation failed.

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 103 of file validatorrequiredifstash.cpp.

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

Referenced by ~ValidatorRequiredIfStash().

validate()

ValidatorReturnType ValidatorRequiredIfStash::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 20 of file validatorrequiredifstash.cpp.

References ValidatorRequiredIfStash(), QString::contains(), QStringList::contains(), Cutelyst::ValidatorRule::debugString(), Cutelyst::ValidatorReturnType::errorMessage, QString::isEmpty(), QMetaType::QString, QMetaType::QStringList, QMetaType::QVariantList, QVariant::setValue(), Cutelyst::Context::stash(), QVariant::toList(), QVariant::toString(), QVariant::toStringList(), QVariant::typeId(), Cutelyst::ValidatorRule::validationDataError(), Cutelyst::ValidatorRule::validationError(), Cutelyst::ValidatorReturnType::value, and Cutelyst::ValidatorRule::value().

Referenced by ~ValidatorRequiredIfStash(), and validateCb().

validateCb()

void ValidatorRequiredIfStash::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 paramter value as QString.

Since

Cutelyst 5.0.0

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 96 of file validatorrequiredifstash.cpp.

References validate().

Referenced by ~ValidatorRequiredIfStash().