cutelyst  4.5.1
A C++ Web Framework built on top of Qt, using the simple approach of Catalyst (Perl) framework.
Cutelyst::ValidatorDate Class Reference

Checks if the input data is a valid date. More...

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

Inheritance diagram for Cutelyst::ValidatorDate:

Public Member Functions

 ValidatorDate (const QString &field, const char *inputFormat=nullptr, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString())
 
 ~ValidatorDate () 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
 
- Protected Member Functions inherited from Cutelyst::ValidatorRule
 ValidatorRule (ValidatorRulePrivate &dd)
 
QString debugString (Context *c) const
 
void defaultValue (Context *c, ValidatorReturnType *result) 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 (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
 

Detailed Description

This validator checks if the input field can be parsed into a QDate, it will check the parsing ability and will convert the input data into a QDate. If a custom inputFormat is given, the validator will at first try to parse the date according to that format. If that fails or if there is no custom inputFormat set, it will try to parse the date based on standard formats in the following order: Context locale's toDate() with QLocale::ShortFormat and QLocale::LongFormat, Qt::ISODate, Qt::RFC2822Date, Qt::TextDate

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 QDate.
See also
Validator for general usage of validators.
ValidatorDateTime, ValidatorTime

Definition at line 41 of file validatordate.h.

Constructor & Destructor Documentation

◆ ValidatorDate()

ValidatorDate::ValidatorDate ( const QString field,
const char *  inputFormat = nullptr,
const ValidatorMessages messages = ValidatorMessages(),
const QString defValKey = QString() 
)

Constructs a new ValidatorDate with the given parameters.

Parameters
fieldName of the input field to validate.
inputFormatOptional input format for input data parsing, can be translatable.
messagesCustom error messages if validation fails.
defValKeyStash key containing a default value if input field is empty. This value will NOT be validated.

Definition at line 12 of file validatordate.cpp.

◆ ~ValidatorDate()

ValidatorDate::~ValidatorDate ( )
overridedefault

Destroys the VaidatorDate object.

Member Function Documentation

◆ genericValidationError()

QString ValidatorDate::genericValidationError ( Context c,
const QVariant errorData = QVariant() 
) const
overrideprotectedvirtual

Returns a generic error if validation failed.

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 47 of file validatordate.cpp.

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

◆ validate()

ValidatorReturnType ValidatorDate::validate ( Context c,
const ParamsMultiMap params 
) const
overrideprotectedvirtual