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

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

Inheritance diagram for Cutelyst::ValidatorTime:

Public Member Functions
	ValidatorTime (const QString &field, const char *format=nullptr, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString())

	~ValidatorTime () 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 QTime, it will check the parsing ability and will convert the input data into a QTime. If a custom format 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 QTime.

See also: Validator for general usage of validators.; ValidatorDateTime, ValidatorDate

Definition at line 43 of file validatortime.h.

Constructor & Destructor Documentation

◆ ValidatorTime()

ValidatorTime::ValidatorTime	(	const QString &	field,
		const char *	format = `nullptr`,
		const ValidatorMessages &	messages = `ValidatorMessages()`,
		const QString &	defValKey = `QString()`
	)

Constructs a new ValidatorTime object with the given parameters.

Parameters

field	Name of the input field to validate.
format	Optional time format for input parsing, can be translatable.
messages	Custom error messages 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 validatortime.cpp.

◆ ~ValidatorTime()

ValidatorTime::~ValidatorTime ( )

overridedefault

Destroys the ValidatorTime object.

Member Function Documentation

◆ genericValidationError()

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

overrideprotectedvirtual

Returns a generic error if validation failed.

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 48 of file validatortime.cpp.

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

◆ validate()

ValidatorReturnType ValidatorTime::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 paramater value converted into a QTime.

Implements Cutelyst::ValidatorRule.

Definition at line 22 of file validatortime.cpp.

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

Public Member Functions