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 QVariantList &stashValues, const ValidatorMessages &messages=ValidatorMessages())
	Constructs a new required if stash validator. More...
	~ValidatorRequiredIfStash () override
	Deconstructs the required if validator.
Public Member Functions inherited from Cutelyst::ValidatorRule
	ValidatorRule (const QString &field, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString())
	Constructs a new ValidatorRule with the given parameters. More...
virtual	~ValidatorRule ()
	Deconstructs the ValidatorRule.

Protected Member Functions
QString	genericValidationError (Context *c, const QVariant &errorData=QVariant()) const override
	Returns a generic error message if validation failed.
ValidatorReturnType	validate (Context *c, const ParamsMultiMap &params) const override
	Performs the validation and returns the result. More...
Protected Member Functions inherited from Cutelyst::ValidatorRule
	ValidatorRule (ValidatorRulePrivate &dd)
	Constructs a new ValidatorRule object with the given private class. More...
void	defaultValue (Context *c, ValidatorReturnType *result, const char *validatorName) const
	I a defValKey has been set in the constructor, this will try to get the default value from the stash and put it into the result. More...
QString	field () const
	Returns the name of the field to validate. More...
virtual QString	genericParsingError (Context *c, const QVariant &errorData=QVariant()) const
	Returns a generic error message if an error occures while parsing input. More...
virtual QString	genericValidationDataError (Context *c, const QVariant &errorData=QVariant()) const
	Returns a generic error message if any validation data is missing or invalid. More...
QString	label (Context *c) const
	Returns the human readable field label used for generic error messages. More...
QString	parsingError (Context *c, const QVariant &errorData=QVariant()) const
	Returns an error message if an error occured while parsing input. More...
bool	trimBefore () const
	Returns true if the field value should be trimmed before validation. More...
QString	validationDataError (Context *c, const QVariant &errorData=QVariant()) const
	Returns an error message if any validation data is missing or invalid. More...
QString	validationError (Context *c, const QVariant &errorData=QVariant()) const
	Returns a descriptive error message if validation failed. More...
QString	value (const ParamsMultiMap &params) const
	Returns the value of the field from the input params.

Detailed Description

If the value of the stash key is equal to one of the values defined in the stashValues list, the input field under validation must be present and not empty. This validator is the opposite of ValidatorRequiredUnlessStash and it 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.

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 QVariantList &	stashValues,
		const ValidatorMessages &	messages = ValidatorMessages()
	)

Parameters

field	Name of the input field to validate.
stashKey	Name of the stash key to compare against.
stashValues	Values in the stashKey from which one must match the content of the stash key to require the field.
messages	Custom error messages if validation fails.

Definition at line 23 of file validatorrequiredifstash.cpp.

Member Function Documentation

validate()

ValidatorReturnType ValidatorRequiredIfStash::validate ( Context *  c, const ParamsMultiMap &  params  ) const

overrideprotectedvirtual

If validation succeeded, ValidatorReturnType::value will contain the input paramter value as QString.

Implements Cutelyst::ValidatorRule.

Definition at line 32 of file validatorrequiredifstash.cpp.

References Cutelyst::ValidatorReturnType::errorMessage, Cutelyst::ValidatorRule::field(), Cutelyst::Context::stash(), Cutelyst::ValidatorRule::validationDataError(), Cutelyst::ValidatorRule::validationError(), Cutelyst::ValidatorReturnType::value, and Cutelyst::ValidatorRule::value().