Checks a value for only alpha-numeric content. More...

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

Inheritance diagram for Cutelyst::ValidatorAlphaNum:

Public Member Functions
	ValidatorAlphaNum (const QString &field, bool asciiOnly=false, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString())

	~ValidatorAlphaNum () 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, bool asciiOnly=false)
	Returns `true` if value only contains alpha-numeric characters.

Protected Member Functions
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

virtual QString	genericValidationDataError (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 only allowed to contain alpha-numeric characters. If asciiOnly is set to true, only US-ASCII characters are allowed, otherwise all UTF-8 alpha-numeric characters are allowed.

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.

Examples: "Hallo Kuddel!" // invalid

"HalloKöddel2" // valid if asciiOnly is false

" " // valid if trimBefore is true, invaid if trimBefore is false

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

See also: Validator for general usage of validators.; ValidatorAlpha, ValidatorAlphaDash

Definition at line 46 of file validatoralphanum.h.

Constructor & Destructor Documentation

◆ ValidatorAlphaNum()

ValidatorAlphaNum::ValidatorAlphaNum	(	const QString &	field,
		bool	asciiOnly = `false`,
		const ValidatorMessages &	messages = `ValidatorMessages()`,
		const QString &	defValKey = `QString()`
	)

Constructs a new ValidatorAlphaNum object with the given parameters.

Parameters

field	Name of the input field to validate.
asciiOnly	If `true`, only ASCII characters are allowed.
messages	Custom error message if validation fails.
defValKey	Stash key containing a default value if input field is empty. This value will NOT be validated.

Definition at line 12 of file validatoralphanum.cpp.

◆ ~ValidatorAlphaNum()

ValidatorAlphaNum::~ValidatorAlphaNum ( )

overridedefault

Destryos the ValidatorAlphaNum object.

Member Function Documentation

◆ genericValidationError()

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

overrideprotectedvirtual

Returns a generic error message.

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 67 of file validatoralphanum.cpp.

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

◆ validate()

ValidatorReturnType ValidatorAlphaNum::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 22 of file validatoralphanum.cpp.

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

Public Member Functions

Static Public Member Functions