Cutelyst::ValidatorTime Class Reference

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())
	Constructs a new time validator. More...
	~ValidatorTime () override
	Deconstructs time the validator.
Public Member Functions inherited from Cutelyst::ValidatorRule
	ValidatorRule (const QString &field, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString())
	Constructs a new ValidatorRule with the given parameters. More...
virtual	~ValidatorRule ()
	Deconstructs the ValidatorRule.

Protected Member Functions
QString	genericValidationError (Context *c, const QVariant &errorData=QVariant()) const override
	Returns a generic error if validation failed.
ValidatorReturnType	validate (Context *c, const ParamsMultiMap &params) const override
	Performs the validation and returns the result. More...
Protected Member Functions inherited from Cutelyst::ValidatorRule
	ValidatorRule (ValidatorRulePrivate &dd)
	Constructs a new ValidatorRule object with the given private class. More...
void	defaultValue (Context *c, ValidatorReturnType *result, const char *validatorName) const
	I a defValKey has been set in the constructor, this will try to get the default value from the stash and put it into the result. More...
QString	field () const
	Returns the name of the field to validate. More...
virtual QString	genericParsingError (Context *c, const QVariant &errorData=QVariant()) const
	Returns a generic error message if an error occures while parsing input. More...
virtual QString	genericValidationDataError (Context *c, const QVariant &errorData=QVariant()) const
	Returns a generic error message if any validation data is missing or invalid. More...
QString	label (Context *c) const
	Returns the human readable field label used for generic error messages. More...
QString	parsingError (Context *c, const QVariant &errorData=QVariant()) const
	Returns an error message if an error occured while parsing input. More...
bool	trimBefore () const
	Returns true if the field value should be trimmed before validation. More...
QString	validationDataError (Context *c, const QVariant &errorData=QVariant()) const
	Returns an error message if any validation data is missing or invalid. More...
QString	validationError (Context *c, const QVariant &errorData=QVariant()) const
	Returns a descriptive error message if validation failed. More...
QString	value (const ParamsMultiMap &params) const
	Returns the value of the field from the input params.

Detailed Description

This validator checks if the input field can be parsed into a QTime, it will check the parsing ability but will not 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.

See also

Validator for general usage of validators.

ValidatorDateTime, ValidatorDate

Definition at line 49 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()
	)

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 24 of file validatortime.cpp.

Member Function Documentation

validate()

ValidatorReturnType ValidatorTime::validate ( Context *  c, const ParamsMultiMap &  params  ) const

overrideprotectedvirtual

If validation succeeded, ValidatorReturnType::value will contain the input paramater value converted into a QTime.

Implements Cutelyst::ValidatorRule.

Definition at line 33 of file validatortime.cpp.

References Cutelyst::ValidatorRule::defaultValue(), Cutelyst::ValidatorReturnType::errorMessage, Cutelyst::ValidatorRule::field(), Cutelyst::ValidatorRule::validationError(), Cutelyst::ValidatorReturnType::value, and Cutelyst::ValidatorRule::value().