Cutelyst::ValidatorAlpha Class Reference

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={}, const QString &defValKey={})
	~ValidatorAlpha () 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 alphabetic characters.

Protected Member Functions
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
virtual QString	genericValidationDataError (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 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

Return type

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

See also

Validator for general usage of validators.

ValidatorAlphaDash, ValidatorAlphaNum

Definition at line 45 of file validatoralpha.h.

Constructor & Destructor Documentation

ValidatorAlpha()

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

explicit

Constructs a new ValidatorAlpha 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 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 13 of file validatoralpha.cpp.

~ValidatorAlpha()

ValidatorAlpha::~ValidatorAlpha ( )

overridedefault

Destroys the ValidatorAlpha object.

Member Function Documentation

genericValidationError()

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

overrideprotectedvirtual

Returns a generic error message if validation failed.

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 73 of file validatoralpha.cpp.

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

validate()

ValidatorReturnType ValidatorAlpha::validate ( Cutelyst::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 23 of file validatoralpha.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().

validateCb()

void ValidatorAlpha::validateCb ( Context *  c, const ParamsMultiMap &  params, ValidatorRtFn  cb  ) const

overrideprotectedvirtual

Performs the validation on the input params and calls the cb with the ValidatorReturnType as argument.

If validation succeeded, ValidatorReturnType::value will contain the input paramter value as QString.

Since

Cutelyst 5.0.0

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 46 of file validatoralpha.cpp.

References validate().