Cutelyst::ValidatorCharNotAllowed Class Reference

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=QString())
	~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 bool	validate (const QString &value, const QString &forbiddenChars, QChar *foundChar=nullptr)
	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
Protected Member Functions inherited from Cutelyst::ValidatorRule
	ValidatorRule (ValidatorRulePrivate &dd)
QString	debugString (Context *c) const
void	defaultValue (Context *c, ValidatorReturnType *result) const
QString	field () const noexcept
virtual QString	genericParsingError (Context *c, const QVariant &errorData={}) const
QString	label (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

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 = QString() )

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.

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

Referenced by ~ValidatorCharNotAllowed(), genericValidationError(), and validate().

~ValidatorCharNotAllowed()

ValidatorCharNotAllowed::~ValidatorCharNotAllowed ( )

overridedefault

Destroys the ValidatorCharNotAllowed object.

References ValidatorCharNotAllowed(), genericValidationDataError(), genericValidationError(), validate(), and Cutelyst::ValidatorRule::value().

Member Function Documentation

genericValidationDataError()

QString ValidatorCharNotAllowed::genericValidationDataError ( Context * c, const QVariant & errorData = QVariant() ) const

overrideprotectedvirtual

Returns a generic error if the list of forbidden characters is empty.

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 88 of file validatorcharnotallowed.cpp.

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

Referenced by ~ValidatorCharNotAllowed().

genericValidationError()

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

overrideprotectedvirtual

Returns a generic error message if validation failed.

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 66 of file validatorcharnotallowed.cpp.

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

Referenced by ~ValidatorCharNotAllowed().

validate()

ValidatorReturnType ValidatorCharNotAllowed::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 39 of file validatorcharnotallowed.cpp.

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