Validates an input field for only alphabetic content. More...

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

Inheritance diagram for Cutelyst::ValidatorAlpha:

Public Member Functions
	ValidatorAlpha (const QString &field, bool asciiOnly=false, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString())
	Constructs a new alpha validator.
	~ValidatorAlpha () override
	Deconstructs the alpha 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.
virtual	~ValidatorRule ()
	Deconstructs the ValidatorRule.

Static Public Member Functions
static bool	validate (const QString &value, bool asciiOnly=false)
	Returns `true` if value only contains alphabetic characters.

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.
Protected Member Functions inherited from Cutelyst::ValidatorRule
	ValidatorRule (ValidatorRulePrivate &dd)
	Constructs a new ValidatorRule object with the given private class.
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.
QString	field () const
	Returns the name of the field to validate.
virtual QString	genericParsingError (Context *c, const QVariant &errorData=QVariant()) const
	Returns a generic error message if an error occures while parsing input.
virtual QString	genericValidationDataError (Context *c, const QVariant &errorData=QVariant()) const
	Returns a generic error message if any validation data is missing or invalid.
QString	label (Context *c) const
	Returns the human readable field label used for generic error messages.
QString	parsingError (Context *c, const QVariant &errorData=QVariant()) const
	Returns an error message if an error occurred while parsing input.
bool	trimBefore () const
	Returns true if the field value should be trimmed before validation.
QString	validationDataError (Context *c, const QVariant &errorData=QVariant()) const
	Returns an error message if any validation data is missing or invalid.
QString	validationError (Context *c, const QVariant &errorData=QVariant()) const
	Returns a descriptive error message if validation failed.
QString	value (const ParamsMultiMap &params) const
	Returns the value of the field from the input params.

Detailed Description

The field under validation is only allowed to contain alphabetic 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öddel" // valid if asciiOnly is false, otherwise it is false

"HalloKuddel" // valid if asciiOnly is true

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

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

Definition at line 44 of file validatoralpha.h.

Constructor & Destructor Documentation

◆ ValidatorAlpha()

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

Parameters

field	Name of the input field to validate.
asciiOnly	If `true`, only ASCII characters are allowed.
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.