Checks if the inut data is valid JSON. More...

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

Inheritance diagram for Cutelyst::ValidatorJson:

Public Member Functions
	ValidatorJson (const QString &field, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString())
	Constructs a new json validator. More...

	~ValidatorJson () override
	Deconstructs the json 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 message if validation failed. More...

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 tries to load the input field string into a QJsonDocument and checks if it is not null and not empty.

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.

Definition at line 43 of file validatorjson.h.

Constructor & Destructor Documentation

◆ ValidatorJson()

ValidatorJson::ValidatorJson	(	const QString &	field,
		const ValidatorMessages &	messages = `ValidatorMessages()`,
		const QString &	defValKey = `QString()`
	)

Parameters

field	Name of the input field to validate.
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 25 of file validatorjson.cpp.

Member Function Documentation

◆ genericValidationError()

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

overrideprotectedvirtual

Parameters

c	The current context, used for translations.
errorData	Will contain the error string from QJsonParseError.

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 56 of file validatorjson.cpp.

References Cutelyst::ValidatorRule::label(), and Cutelyst::Context::translate().

◆ validate()

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

overrideprotectedvirtual

If validation succeeded, ValidatorReturnType::value will contain the input paramter value converted into a QJsonDocument.

Implements Cutelyst::ValidatorRule.

Definition at line 34 of file validatorjson.cpp.

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