cutelyst  3.9.1
A C++ Web Framework built on top of Qt, using the simple approach of Catalyst (Perl) framework.
validatorresult.h
1 /*
2  * SPDX-FileCopyrightText: (C) 2017-2022 Matthias Fehring <mf@huessenbergnetz.de>
3  * SPDX-License-Identifier: BSD-3-Clause
4  */
5 #ifndef CUTELYSTVALIDATORRESULT_H
6 #define CUTELYSTVALIDATORRESULT_H
7 
8 #include <Cutelyst/cutelyst_global.h>
9 
10 #include <QJsonObject>
11 #include <QSharedDataPointer>
12 #include <QString>
13 #include <QStringList>
14 #include <QVariantHash>
15 
16 namespace Cutelyst {
17 
18 class ValidatorResultPrivate;
19 
71 class CUTELYST_PLUGIN_UTILS_VALIDATOR_EXPORT ValidatorResult
72 {
73 public:
81 
85  ValidatorResult(const ValidatorResult &other);
86 
90  ValidatorResult &operator=(const ValidatorResult &other);
91 
95  ~ValidatorResult();
96 
102  bool isValid() const;
103 
110  void addError(const QString &field, const QString &message);
111 
116  QStringList errorStrings() const;
117 
124  QHash<QString, QStringList> errors() const;
125 
133  QStringList errors(const QString &field) const;
134 
142  bool hasErrors(const QString &field) const;
143 
154  QJsonObject errorsJsonObject() const;
155 
161  QStringList failedFields() const;
162 
168  explicit operator bool() const { return isValid(); }
169 
177  QVariantHash values() const;
178 
187  QVariant value(const QString &field) const;
188 
195  void addValue(const QString &field, const QVariant &value);
196 
205  QVariantHash extras() const;
206 
215  QVariant extra(const QString &field) const;
216 
223  void addExtra(const QString &field, const QVariant &extra);
224 
225 private:
227 };
228 
229 } // namespace Cutelyst
230 
231 #endif // CUTELYSTVALIDATORRESULT_H
The Cutelyst namespace holds all public Cutelyst API.
Definition: Mainpage.dox:7
Provides information about performed validations.