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={}, const QString &defValKey={})
	~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
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
	Void callback function for validator rules that processes the ValidatorReturnType.

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 time according to that format. If that fails or if there is no custom inputFormat set, it will try to parse the time 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 41 of file validatortime.h.

Constructor & Destructor Documentation

◆ ValidatorTime()

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

explicit

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.