Cutelyst::ValidatorBefore Class Reference

Checks if a date, time or datetime is before a comparison value. More...

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

Inheritance diagram for Cutelyst::ValidatorBefore:

Public Member Functions
	ValidatorBefore (const QString &field, const QVariant &comparison, const QString &timeZone=QString(), const char *inputFormat=nullptr, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString())
	~ValidatorBefore () 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	genericParsingError (Context *c, const QVariant &errorData=QVariant()) const override
QString	genericValidationDataError (Context *c, const QVariant &errorData=QVariant()) const override
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
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 will check if the date, time or datetime in the input field is later than the comparison value set in the constructor or via setComparison(). It depends on the comparison value how the input data is handled. If the comparison value is a QDateTime, the input data will be converted into a QDateTime to compare the both values. The same happens for QTime and QDate. It is also possible to use a QString as comparison value. Using a QString makes it possible to compare the input field against a value from the stash.

To specify a time zone that should be used for the input field - and the comparison input field if one is used, give either the IANA time zone ID name to the timeZone argument of the constructor or the name of an input field or stash key that contains the ID name. It will then be first tried to create a valid QTimeZone from the timeZone, if that fails it will try to get the time zone from the input parameters and if there is no key with the name trying it with the stash. Stash or input parameter can either contain a valid IANA time zone ID or the offset from UTC in seconds.

If the input data can not be parsed into a comparable format, the validation fails and ValidatorRule::parsingError() will return the error string. It will also fail if the comparative value is not of type QDate, QTime, QDateTime or QString. Use inputFormat parameter of the constructor to set a custom input 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 and 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.

Examples

void MyController::form_do(Context *c)
{
    Validator v({
                 // compare against a specific date
                 new ValidatorBefore(QStringLiteral("datefield"), QDate(2018, 1, 1)),
 
                 // compare against a specific date and time that might have a format different
                 // for every language
                 new ValidatorBefore(QStringLiteral("datefield2"),
                                     QDateTime::fromString(QStringLiteral("2018-01-01T18:18:18"),
                                                           Qt::ISODate),
                                     QString(),
                                     QT_TRANSLATE_NOOP("MyController", "yyyy-MM-ddTHH:mm:ss")),
 
                 // compare against a datetime in the stash
                 new ValidatorBefore(QStringLiteral("datetime"), QStringLiteral("stashkey")),
 
                 // compare against a datetime and set the input fields time zone
                 new ValidatorBefore(QStringLiteral("datetime2"),
                                     QDateTime(QDate(2018, 1, 15),
                                               QTime(12,0),
                                               QTimeZone(QByteArrayLiteral("Europe/Berlin")),
                                     QStringLiteral("America/Rio_Branco")),
 
                 // compare against a datetime and read input fields time zone from another
                 // input field
                 new ValidatorBefore(QStringLiteral("datetime3"),
                                     QDateTime(QDate(2018, 1, 15),
                                               QTime(12,0),
                                               QTimeZone(QByteArrayLiteral("Europe/Berlin")),
                                     QStringLiteral("tz_field"))
               }, QLatin1String("MyController"));
}

Return type

On success, ValidatorReturnType::value will contain a QDateTime, QDate or QTime, according to the type of the comparison value.

See also

Validator for general usage of validators.

ValidatorAfter

Definition at line 96 of file validatorbefore.h.

Constructor & Destructor Documentation

ValidatorBefore()

ValidatorBefore::ValidatorBefore	(	const QString &	field,
		const QVariant &	comparison,
		const QString &	timeZone = QString(),
		const char *	inputFormat = nullptr,
		const ValidatorMessages &	messages = ValidatorMessages(),
		const QString &	defValKey = QString()
	)

Constructs a new ValidatorBefore object with the given parameters.

Parameters

field	Name of the input field to validate.
comparison	The value or stash key to compare against.
timeZone	IANA time zone ID, name of an input field containing the ID or stash key containing the ID.
inputFormat	Optional input format for input data parsing, can be translatable.
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 12 of file validatorbefore.cpp.

~ValidatorBefore()

ValidatorBefore::~ValidatorBefore ( )

overridedefault

Destroys the ValidatorBefore object.

Member Function Documentation

genericParsingError()

QString ValidatorBefore::genericParsingError ( Context *  c, const QVariant &  errorData = QVariant()  ) const

overrideprotectedvirtual

Returns a generic error if the input value could not be parsed.

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 190 of file validatorbefore.cpp.

References QString::arg(), QString::isEmpty(), Cutelyst::ValidatorRule::label(), QMetaType::QDate, QMetaType::QDateTime, QMetaType::QTime, Cutelyst::Context::qtTrId(), Cutelyst::Context::translate(), QVariant::userType(), and Cutelyst::ValidatorRule::validationDataError().

genericValidationDataError()

QString ValidatorBefore::genericValidationDataError ( Context *  c, const QVariant &  errorData = QVariant()  ) const

overrideprotectedvirtual

Returns a generic error if comparison data was invalid.

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 178 of file validatorbefore.cpp.

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

genericValidationError()

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

overrideprotectedvirtual

Returns a generic error if validation failed.

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 127 of file validatorbefore.cpp.

References QString::arg(), QString::isEmpty(), Cutelyst::ValidatorRule::label(), Cutelyst::Context::locale(), QMetaType::QDate, QMetaType::QDateTime, QMetaType::QTime, Cutelyst::Context::qtTrId(), QLocale::ShortFormat, QVariant::toDate(), QVariant::toDateTime(), QLocale::toString(), QVariant::toTime(), QVariant::userType(), and Cutelyst::ValidatorRule::validationDataError().

validate()

ValidatorReturnType ValidatorBefore::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 converted input parameter value as QDateTime, QDate or QTime, according to the type of the comparison value.

Implements Cutelyst::ValidatorRule.

Definition at line 29 of file validatorbefore.cpp.

References Cutelyst::ValidatorRule::debugString(), Cutelyst::ValidatorRule::defaultValue(), Cutelyst::ValidatorReturnType::errorMessage, QString::isEmpty(), QDateTime::isValid(), QTime::isValid(), QDate::isValid(), Cutelyst::ValidatorRule::parsingError(), QMetaType::QDate, QMetaType::QDateTime, QMetaType::QString, QMetaType::QTime, QVariant::setValue(), QVariant::toDate(), QVariant::toDateTime(), QVariant::toTime(), QVariant::userType(), Cutelyst::ValidatorRule::validationDataError(), Cutelyst::ValidatorRule::validationError(), Cutelyst::ValidatorReturnType::value, and Cutelyst::ValidatorRule::value().