Cutelyst::ValidatorRequiredWithoutAll Class Reference

The field under validation must be present and not empty only when all of the other specified fields are not present. More...

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

Inheritance diagram for Cutelyst::ValidatorRequiredWithoutAll:

Public Member Functions
	ValidatorRequiredWithoutAll (const QString &field, const QStringList &otherFields, const ValidatorMessages &messages=ValidatorMessages())
	~ValidatorRequiredWithoutAll () 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 all of the fields specified in the otherFields list are not present in the input data, the field under validation must be present and not empty. For the other fields it will only be checked if they are not part of the input data, 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, ValidatorRequiredWith, ValidatorRequiredWithAll, ValidatorRequiredWithout

Definition at line 39 of file validatorrequiredwithoutall.h.

Constructor & Destructor Documentation

ValidatorRequiredWithoutAll()

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

Constructs a new ValidatorRequiredWithoutAll object with the given parameters.

Parameters

field	Name of the input field to validate.
otherFields	List of field names that are not allowed to be present to require the field.
messages	Custom error messages if validation fails.

Definition at line 10 of file validatorrequiredwithoutall.cpp.

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

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

~ValidatorRequiredWithoutAll()

ValidatorRequiredWithoutAll::~ValidatorRequiredWithoutAll ( )

overridedefault

Destroys the ValidatorRequiredWithoutAll object.

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

Member Function Documentation

genericValidationError()

QString ValidatorRequiredWithoutAll::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 validatorrequiredwithoutall.cpp.

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

Referenced by ~ValidatorRequiredWithoutAll().

validate()

ValidatorReturnType ValidatorRequiredWithoutAll::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 validatorrequiredwithoutall.cpp.

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

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

validateCb()

void ValidatorRequiredWithoutAll::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 55 of file validatorrequiredwithoutall.cpp.

References validate().

Referenced by ~ValidatorRequiredWithoutAll().