Cutelyst  2.13.0
validatorurl.h
1 /*
2  * Copyright (C) 2017-2018 Matthias Fehring <kontakt@buschmann23.de>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18 #ifndef CUTELYSTVALIDATORURL_H
19 #define CUTELYSTVALIDATORURL_H
20 
21 #include <Cutelyst/cutelyst_global.h>
22 #include "validatorrule.h"
23 
24 namespace Cutelyst {
25 
26 class ValidatorUrlPrivate;
27 
43 class CUTELYST_PLUGIN_UTILS_VALIDATOR_EXPORT ValidatorUrl : public ValidatorRule
44 {
45 public:
49  enum Constraint {
50  NoConstraint = 0,
51  StrictParsing = 1,
52  NoRelative = 2,
53  NoLocalFile = 4,
54  WebsiteOnly = 8,
55  };
56  Q_DECLARE_FLAGS(Constraints, Constraint)
57 
58 
66  ValidatorUrl(const QString &field, Constraints constraints = NoConstraint, const QStringList &schemes = QStringList(), const ValidatorMessages &messages = ValidatorMessages(), const QString &defValKey = QString());
67 
71  ~ValidatorUrl() override;
72 
73 protected:
80  ValidatorReturnType validate(Context *c, const ParamsMultiMap &params) const override;
81 
85  QString genericValidationError(Context *c, const QVariant &errorData = QVariant()) const override;
86 
87 private:
88  Q_DECLARE_PRIVATE(ValidatorUrl)
89  Q_DISABLE_COPY(ValidatorUrl)
90 };
91 
92 }
93 
94 Q_DECLARE_OPERATORS_FOR_FLAGS(Cutelyst::ValidatorUrl::Constraints)
95 
96 #endif //CUTELYSTVALIDATORURL_H
97 
Cutelyst::ValidatorUrl::Constraint
Constraint
Constraints to limit the validation.
Definition: validatorurl.h:49
Cutelyst::ParamsMultiMap
QMap< QString, QString > ParamsMultiMap
Definition: paramsmultimap.h:36
Cutelyst::ValidatorMessages
Stores custom error messages and the input field label.
Definition: validatorrule.h:144
Cutelyst::Context
The Cutelyst Context.
Definition: context.h:50
Cutelyst::ValidatorRule
Base class for all validator rules.
Definition: validatorrule.h:292
Cutelyst::ValidatorReturnType
Contains the result of a single input parameter validation.
Definition: validatorrule.h:62
Cutelyst
The Cutelyst namespace holds all public Cutelyst API.
Definition: Mainpage.dox:7
Cutelyst::ValidatorUrl
The field under validation must be a valid URL.
Definition: validatorurl.h:43