Cutelyst::ValidatorDifferent Class Reference

Checks if two values are different. More...

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

Inheritance diagram for Cutelyst::ValidatorDifferent:

Public Member Functions
	ValidatorDifferent (const QString &field, const QString &other, const char *otherLabel=nullptr, const ValidatorMessages &messages=ValidatorMessages())
	Constructs a new different validator. More...
	~ValidatorDifferent () override
	Deconstructs the different 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 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

This will check if the value in the one input field is different from the value in the other input field.

Note

Unless validation is started with NoTrimming, whitespaces will be removed from the beginning and the end of the input value before validation. If the field's value is empty or if the field is missing in the input data, the validation will succeed without performing the validation itself. Use one of the required validators to require the field to be present and not empty.

See also

Validator for general usage of validators.

ValidatorSame

Definition at line 45 of file validatordifferent.h.

Constructor & Destructor Documentation

ValidatorDifferent()

ValidatorDifferent::ValidatorDifferent	(	const QString &	field,
		const QString &	other,
		const char *	otherLabel = nullptr,
		const ValidatorMessages &	messages = ValidatorMessages()
	)

Parameters

field	Name of the input field to validate.
other	Name of the other field to compare against.
otherLabel	Translatable label of the other input field, used for generic error messages.
messages	Custom error messages if validation fails.

Definition at line 23 of file validatordifferent.cpp.

Member Function Documentation

validate()

ValidatorReturnType ValidatorDifferent::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 validatordifferent.cpp.

References Cutelyst::ValidatorReturnType::errorMessage, Cutelyst::ValidatorRule::field(), Cutelyst::ValidatorRule::trimBefore(), Cutelyst::ValidatorRule::validationError(), Cutelyst::ValidatorReturnType::value, and Cutelyst::ValidatorRule::value().