Cutelyst::ValidatorRequiredIf Class Reference

The field under validation must be present and not empty if the other field is equal to any value in a list. More...

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

Inheritance diagram for Cutelyst::ValidatorRequiredIf:

Public Member Functions
	ValidatorRequiredIf (const QString &field, const QString &otherField, const QStringList &otherValues, const ValidatorMessages &messages=ValidatorMessages())
	~ValidatorRequiredIf () 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 other field specified as otherField contains any of the values defined in the otherValues list, the field under validation must be present and not empty. This validator is the opposite of ValidatorRequiredUnless.

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

Definition at line 39 of file validatorrequiredif.h.

Constructor & Destructor Documentation

ValidatorRequiredIf()

ValidatorRequiredIf::ValidatorRequiredIf	(	const QString &	field,
		const QString &	otherField,
		const QStringList &	otherValues,
		const ValidatorMessages &	messages = ValidatorMessages() )

Constructs a new ValidatorRequiredIf object with the given parameters.

Parameters

field	Name of the input field to validate.
otherField	Name of the other input field to validate.
otherValues	Values in the other field from which one must match the other field’s content to require the main field.
messages	Custom error messages if validation fails.

Definition at line 10 of file validatorrequiredif.cpp.

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

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

~ValidatorRequiredIf()

ValidatorRequiredIf::~ValidatorRequiredIf ( )

overridedefault

Destroys the ValidatorRequiredIf object.

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

Member Function Documentation

genericValidationError()

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

overrideprotectedvirtual

Returns a generic error message if validation failed.

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 59 of file validatorrequiredif.cpp.

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

Referenced by ~ValidatorRequiredIf().

validate()

ValidatorReturnType ValidatorRequiredIf::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 validatorrequiredif.cpp.

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

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

validateCb()

void ValidatorRequiredIf::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 52 of file validatorrequiredif.cpp.

References validate().

Referenced by ~ValidatorRequiredIf().