Cutelyst::ValidatorReturnType Struct Reference

Contains the result of a single input parameter validation. More...

#include <Cutelyst/Plugins/Utils/ValidatorRule>

Public Member Functions
bool	isValid () const noexcept
	operator bool () const noexcept

Public Attributes
QString	errorMessage
QVariant	extra
QVariant	value

Detailed Description

For information about the possible values of value and extra see the documentation of the respective validator rule.

Definition at line 52 of file validatorrule.h.

Member Function Documentation

isValid()

bool Cutelyst::ValidatorReturnType::isValid ( ) const

inlinenodiscardnoexcept

Returns true if validation succeeded what means that errorMessage is a null string.

Definition at line 73 of file validatorrule.h.

References errorMessage.

operator bool()

Cutelyst::ValidatorReturnType::operator bool ( ) const

inlineexplicitnoexcept

Returns true if validation succeeded what means that errorMessage is a null string.

Definition at line 68 of file validatorrule.h.

References errorMessage.

Member Data Documentation

errorMessage

QString Cutelyst::ValidatorReturnType::errorMessage

Contains a human readable error message if validation failed that should provide information about the reason the validation failed. If QString::isNull() returns true for this, the validation has succeeded and isValid() will alsor return true.

Definition at line 53 of file validatorrule.h.

Referenced by isValid(), operator bool(), Cutelyst::Validator::validate(), Cutelyst::ValidatorAccepted::validate(), Cutelyst::ValidatorAfter::validate(), Cutelyst::ValidatorAlpha::validate(), Cutelyst::ValidatorAlphaDash::validate(), Cutelyst::ValidatorAlphaNum::validate(), Cutelyst::ValidatorBefore::validate(), Cutelyst::ValidatorBetween::validate(), Cutelyst::ValidatorBoolean::validate(), Cutelyst::ValidatorCharNotAllowed::validate(), Cutelyst::ValidatorConfirmed::validate(), Cutelyst::ValidatorDate::validate(), Cutelyst::ValidatorDateTime::validate(), Cutelyst::ValidatorDifferent::validate(), Cutelyst::ValidatorDigits::validate(), Cutelyst::ValidatorDigitsBetween::validate(), Cutelyst::ValidatorDomain::validate(), Cutelyst::ValidatorEmail::validate(), Cutelyst::ValidatorFileSize::validate(), Cutelyst::ValidatorFilled::validate(), Cutelyst::ValidatorIn::validate(), Cutelyst::ValidatorInteger::validate(), Cutelyst::ValidatorIp::validate(), Cutelyst::ValidatorJson::validate(), Cutelyst::ValidatorMax::validate(), Cutelyst::ValidatorMin::validate(), Cutelyst::ValidatorNotIn::validate(), Cutelyst::ValidatorNumeric::validate(), Cutelyst::ValidatorPresent::validate(), Cutelyst::ValidatorPwQuality::validate(), Cutelyst::ValidatorRegularExpression::validate(), Cutelyst::ValidatorRequired::validate(), Cutelyst::ValidatorRequiredIf::validate(), Cutelyst::ValidatorRequiredIfStash::validate(), Cutelyst::ValidatorRequiredUnless::validate(), Cutelyst::ValidatorRequiredUnlessStash::validate(), Cutelyst::ValidatorRequiredWith::validate(), Cutelyst::ValidatorRequiredWithAll::validate(), Cutelyst::ValidatorRequiredWithout::validate(), Cutelyst::ValidatorRequiredWithoutAll::validate(), Cutelyst::ValidatorSame::validate(), Cutelyst::ValidatorSize::validate(), Cutelyst::ValidatorTime::validate(), and Cutelyst::ValidatorUrl::validate().

extra

QVariant Cutelyst::ValidatorReturnType::extra

Might contain extra data provided by the validator. For information about the possible values see the documentation of the respective validator.

Definition at line 61 of file validatorrule.h.

Referenced by Cutelyst::Validator::validate(), and Cutelyst::ValidatorEmail::validate().

value

QVariant Cutelyst::ValidatorReturnType::value

Might contain the extracted and possibly converted value of the input parameter if validation succeeded. For information about the possible values see the documentation of the respective validator.

Definition at line 57 of file validatorrule.h.

Referenced by Cutelyst::ValidatorRule::defaultValue(), Cutelyst::Validator::validate(), Cutelyst::ValidatorAccepted::validate(), Cutelyst::ValidatorAfter::validate(), Cutelyst::ValidatorAlpha::validate(), Cutelyst::ValidatorAlphaDash::validate(), Cutelyst::ValidatorAlphaNum::validate(), Cutelyst::ValidatorBefore::validate(), Cutelyst::ValidatorBetween::validate(), Cutelyst::ValidatorBoolean::validate(), Cutelyst::ValidatorCharNotAllowed::validate(), Cutelyst::ValidatorConfirmed::validate(), Cutelyst::ValidatorDate::validate(), Cutelyst::ValidatorDateTime::validate(), Cutelyst::ValidatorDifferent::validate(), Cutelyst::ValidatorDigits::validate(), Cutelyst::ValidatorDigitsBetween::validate(), Cutelyst::ValidatorDomain::validate(), Cutelyst::ValidatorEmail::validate(), Cutelyst::ValidatorFileSize::validate(), Cutelyst::ValidatorFilled::validate(), Cutelyst::ValidatorIn::validate(), Cutelyst::ValidatorInteger::validate(), Cutelyst::ValidatorIp::validate(), Cutelyst::ValidatorJson::validate(), Cutelyst::ValidatorMax::validate(), Cutelyst::ValidatorMin::validate(), Cutelyst::ValidatorNotIn::validate(), Cutelyst::ValidatorNumeric::validate(), Cutelyst::ValidatorPresent::validate(), Cutelyst::ValidatorPwQuality::validate(), Cutelyst::ValidatorRegularExpression::validate(), Cutelyst::ValidatorRequired::validate(), Cutelyst::ValidatorRequiredIf::validate(), Cutelyst::ValidatorRequiredIfStash::validate(), Cutelyst::ValidatorRequiredUnless::validate(), Cutelyst::ValidatorRequiredUnlessStash::validate(), Cutelyst::ValidatorRequiredWith::validate(), Cutelyst::ValidatorRequiredWithAll::validate(), Cutelyst::ValidatorRequiredWithout::validate(), Cutelyst::ValidatorRequiredWithoutAll::validate(), Cutelyst::ValidatorSame::validate(), Cutelyst::ValidatorSize::validate(), Cutelyst::ValidatorTime::validate(), and Cutelyst::ValidatorUrl::validate().