Cutelyst::ValidatorRequired Class Reference

Checks if a field is available and not empty. More...

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

Inheritance diagram for Cutelyst::ValidatorRequired:

Public Member Functions
	ValidatorRequired (const QString &field, const ValidatorMessages &messages={})
	~ValidatorRequired () 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.

Protected Member Functions
QString	genericValidationError (Context *c, const QVariant &errorData=QVariant()) const override
	Returns a generic error message.
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
	Void callback function for validator rules that processes the ValidatorReturnType.

Detailed Description

The field under validation must be present in the input data and not empty.

Note

Unless validation is started with NoTrimming, whitespaces will be removed from the beginning and the end of the input value before validation. So, fields that only contain whitespaces will be treated as empty and are invalid.

Return type

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

See also

Validator for general usage of validators.

ValidatorRequiredIf, ValidatorRequiredUnless, ValidatorRequiredWith, ValidatorRequiredWithAll, ValidatorRequiredWithout, ValidatorRequiredWithoutAll

Definition at line 34 of file validatorrequired.h.

Constructor & Destructor Documentation

ValidatorRequired()

ValidatorRequired::ValidatorRequired ( const QString & field, const ValidatorMessages & messages = {} )

explicit

Constructs a new ValidatorRequired object with the given parameters.

Parameters

field	Name of the input field that is required.
messages	Custom error message if validation fails.

Definition at line 10 of file validatorrequired.cpp.

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

Referenced by ~ValidatorRequired().

~ValidatorRequired()

ValidatorRequired::~ValidatorRequired ( )

overridedefault

Destroys the ValidatorRequired object.

References ValidatorRequired(), genericValidationError(), validate(), and validateCb().

Member Function Documentation

genericValidationError()

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

overrideprotectedvirtual

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 45 of file validatorrequired.cpp.

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

Referenced by ~ValidatorRequired().

validate()

ValidatorReturnType ValidatorRequired::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 parameter value as QString.

Implements Cutelyst::ValidatorRule.

Definition at line 18 of file validatorrequired.cpp.

References QMultiMap::contains(), Cutelyst::ValidatorRule::debugString(), Cutelyst::ValidatorReturnType::errorMessage, Cutelyst::ValidatorRule::field(), QString::isEmpty(), QVariant::setValue(), Cutelyst::ValidatorRule::validationError(), Cutelyst::ValidatorReturnType::value, and Cutelyst::ValidatorRule::value().

Referenced by ~ValidatorRequired(), and validateCb().

validateCb()

void ValidatorRequired::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 40 of file validatorrequired.cpp.

References validate().

Referenced by ~ValidatorRequired().