Cutelyst  2.13.0
validatorpresent.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 CUTELYSTVALIDATORPRESENT_H
19 #define CUTELYSTVALIDATORPRESENT_H
20 
21 #include <Cutelyst/cutelyst_global.h>
22 #include "validatorrule.h"
23 
24 namespace Cutelyst {
25 
26 class ValidatorPresentPrivate;
27 
40 class CUTELYST_PLUGIN_UTILS_VALIDATOR_EXPORT ValidatorPresent : public ValidatorRule
41 {
42 public:
48  ValidatorPresent(const QString &field, const ValidatorMessages &messages = ValidatorMessages());
49 
53  ~ValidatorPresent() override;
54 
55 protected:
62  ValidatorReturnType validate(Context *c, const ParamsMultiMap &params) const override;
63 
67  QString genericValidationError(Context *c, const QVariant &errorData = QVariant()) const override;
68 
69 private:
70  Q_DECLARE_PRIVATE(ValidatorPresent)
71  Q_DISABLE_COPY(ValidatorPresent)
72 };
73 
74 }
75 
76 #endif //CUTELYSTVALIDATORPRESENT_H
77 
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::ValidatorPresent
The field under validation must be present in input data but can be empty.
Definition: validatorpresent.h:40
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