Cutelyst::ValidatorFilled Class Reference

The field under validation must not be empty when it is present. More...

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

Inheritance diagram for Cutelyst::ValidatorFilled:

Public Member Functions
	ValidatorFilled (const QString &field, const ValidatorMessages &messages={}, const QString &defValKey={})
	~ValidatorFilled () 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
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 difference to the required validator is, that it will only be checked for non emptyness if it is available. If it is available, it is not allowed to be empty.

Note

Unless validation is started with NoTrimming, whitespaces will be removed from the beginning and the end of the input value before validation.

Return type

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

See also

Validator for general usage of validators.

ValidatorPresent

Definition at line 34 of file validatorfilled.h.

Constructor & Destructor Documentation

ValidatorFilled()

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

explicit

Constructs a new ValidatorFilled object with the given parameters.

Parameters

field	Name of the input field to validate.
messages	Custom error message if validation fails.

Definition at line 10 of file validatorfilled.cpp.

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

Referenced by ~ValidatorFilled().

~ValidatorFilled()

ValidatorFilled::~ValidatorFilled ( )

overridedefault

Destroys the ValidatorFilled object.

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

Member Function Documentation

genericValidationError()

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

overrideprotectedvirtual

Creates a generic error message.

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 43 of file validatorfilled.cpp.

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

Referenced by ~ValidatorFilled().

validate()

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

Implements Cutelyst::ValidatorRule.

Definition at line 19 of file validatorfilled.cpp.

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

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

validateCb()

void ValidatorFilled::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 parameter value as QString.

Since

Cutelyst 5.0.0

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 38 of file validatorfilled.cpp.

References validate().

Referenced by ~ValidatorFilled().