Cutelyst::ValidatorBoolean Class Reference

Checks if a value can be casted into a boolean. More...

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

Inheritance diagram for Cutelyst::ValidatorBoolean:

Public Member Functions
	ValidatorBoolean (const QString &field, const ValidatorMessages &messages={}, const QString &defValKey={})
	~ValidatorBoolean () 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 = std::function< void(ValidatorReturnType &&result)>
	Void callback function for validator rules that processes the ValidatorReturnType.

Detailed Description

The field under validation must contain one of the following acceptable input values: 1, 0, true, false, on or off.

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.

Return type

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

See also

Validator for general usage of validators.

Definition at line 34 of file validatorboolean.h.

Constructor & Destructor Documentation

ValidatorBoolean()

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

explicit

Constructs a new ValidatorBoolean with the given parameters.

Parameters

field	Name of the input field to validate.
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 16 of file validatorboolean.cpp.

~ValidatorBoolean()

ValidatorBoolean::~ValidatorBoolean ( )

overridedefault

Destroys the ValidatorBoolean object.

Member Function Documentation

genericValidationError()

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

overrideprotectedvirtual

Returns a generic error message if validation failed.

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 53 of file validatorboolean.cpp.

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

validate()

ValidatorReturnType ValidatorBoolean::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 either contain true if the input value contains 1, true or \on, or false if value contains 0, false or off.

Implements Cutelyst::ValidatorRule.

Definition at line 25 of file validatorboolean.cpp.

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

Referenced by validateCb().

validateCb()

void ValidatorBoolean::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 either contain true if the input value contains 1, true or \on, or false if value contains 0, false or off.

Since

Cutelyst 5.0.0

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 48 of file validatorboolean.cpp.

References validate().