The field under validation must be a valid URL. More...

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

Inheritance diagram for Cutelyst::ValidatorUrl:

Public Types
enum	Constraint { NoConstraint , StrictParsing , NoRelative , NoLocalFile , WebsiteOnly }
	Constraints to limit the validation. More...

Public Member Functions
	ValidatorUrl (const QString &field, Constraints constraints=NoConstraint, const QStringList &schemes=QStringList(), const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString())
	Constructs a new url validator.
	~ValidatorUrl () override
	Deconstructs 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.
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.
ValidatorReturnType	validate (Context *c, const ParamsMultiMap &params) const override
	Performs the validation and returns the result.
Protected Member Functions inherited from Cutelyst::ValidatorRule
	ValidatorRule (ValidatorRulePrivate &dd)
	Constructs a new ValidatorRule object with the given private class.
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.
QString	field () const
	Returns the name of the field to validate.
virtual QString	genericParsingError (Context *c, const QVariant &errorData=QVariant()) const
	Returns a generic error message if an error occures while parsing input.
virtual QString	genericValidationDataError (Context *c, const QVariant &errorData=QVariant()) const
	Returns a generic error message if any validation data is missing or invalid.
QString	label (Context *c) const
	Returns the human readable field label used for generic error messages.
QString	parsingError (Context *c, const QVariant &errorData=QVariant()) const
	Returns an error message if an error occurred while parsing input.
bool	trimBefore () const
	Returns true if the field value should be trimmed before validation.
QString	validationDataError (Context *c, const QVariant &errorData=QVariant()) const
	Returns an error message if any validation data is missing or invalid.
QString	validationError (Context *c, const QVariant &errorData=QVariant()) const
	Returns a descriptive error message if validation failed.
QString	value (const ParamsMultiMap &params) const
	Returns the value of the field from the input params.

Detailed Description

Checks if the field contains a valid URL by loading it into a QUrl and testing it's validity.

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 32 of file validatorurl.h.

Member Enumeration Documentation

◆ Constraint

enum Cutelyst::ValidatorUrl::Constraint

Enumerator
NoConstraint	No constraints set.
StrictParsing	String will be parsed in strict mode. See http://doc.qt.io/qt-5/qurl.html#ParsingMode-enum
NoRelative	Relative URLs are not valid.
NoLocalFile	Local file URLs are not Vaid.
WebsiteOnly	Combines NoRelative and NoLocalFile and sets http and https to the schemes list. (Will overwrite existing list)

Definition at line 38 of file validatorurl.h.

Constructor & Destructor Documentation

◆ ValidatorUrl()

ValidatorUrl::ValidatorUrl	(	const QString &	field,
		Constraints	constraints = NoConstraint,
		const QStringList &	schemes = QStringList(),
		const ValidatorMessages &	messages = ValidatorMessages(),
		const QString &	defValKey = QString() )

Parameters

field	Name of the input field to validate.
constraints	Constraints for parsing and validating the URL.
schemes	List of allowed schemes for a valid URL.
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 validatorurl.cpp.

References Cutelyst::ValidatorRule::ValidatorRule(), and Cutelyst::ValidatorRule::field().

Referenced by validate().

◆ ~ValidatorUrl()

ValidatorUrl::~ValidatorUrl ( )

override

Definition at line 21 of file validatorurl.cpp.

Member Function Documentation

◆ genericValidationError()

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

overrideprotectedvirtual

Reimplemented from Cutelyst::ValidatorRule.

Definition at line 111 of file validatorurl.cpp.

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

◆ validate()

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

overrideprotectedvirtual

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

Implements Cutelyst::ValidatorRule.

Definition at line 25 of file validatorurl.cpp.

References ValidatorUrl(), Cutelyst::ValidatorRule::defaultValue(), QList::empty(), Cutelyst::ValidatorReturnType::errorMessage, Cutelyst::ValidatorRule::field(), QString::isEmpty(), QUrl::isEmpty(), QUrl::isLocalFile(), QUrl::isRelative(), QUrl::isValid(), NoLocalFile, NoRelative, QUrl::scheme(), QVariant::setValue(), QUrl::StrictMode, StrictParsing, QUrl::TolerantMode, QString::toLower(), Cutelyst::ValidatorRule::validationError(), Cutelyst::ValidatorReturnType::value, Cutelyst::ValidatorRule::value(), and WebsiteOnly.

Public Types

Public Member Functions

Protected Member Functions