Validates an input field for not allowed characters. More...

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

Inheritance diagram for Cutelyst::ValidatorCharNotAllowed:

Public Member Functions
	ValidatorCharNotAllowed (const QString &field, const QString &forbiddenChars, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey={})

	~ValidatorCharNotAllowed () 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.

Static Public Member Functions
static std::optional< QChar >	validate (const QString &value, const QString &forbiddenChars)
	Returns `true` if value does not contain any of the forbideden characters.

Protected Member Functions
QString	genericValidationDataError (Context *c, const QVariant &errorData=QVariant()) const override

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

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 = std::function< void(ValidatorReturnType &&result)>
	Void callback function for validator rules that processes the ValidatorReturnType.

Detailed Description

The field under validation is not allowed to contain a list of characters. The list of not allowed characters is set as a QString to the forbiddenChars constructor argument.

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.

Return type: On success, ValidatorReturnType::value will contain a QString.

See also: Validator for general usage of validators.; ValidatorRegularExpression

Definition at line 38 of file validatorcharnotallowed.h.

Constructor & Destructor Documentation

◆ ValidatorCharNotAllowed()

ValidatorCharNotAllowed::ValidatorCharNotAllowed	(	const QString &	field,
		const QString &	forbiddenChars,
		const ValidatorMessages &	messages = `ValidatorMessages()`,
		const QString &	defValKey = `{}`
	)

Constructs a new ValidatorCharNotAllowed object with the fiven parameters.

Parameters

field	Name of the input field to validate.
forbiddenChars	List of characters not allowed in the input field.
messages	Custom error messages if validation fails.
defValKey	Stash key containing a default value if input field is empty. This value will NOT be validated.

Definition at line 10 of file validatorcharnotallowed.cpp.