Cutelyst  2.13.0
validatoraccepted.cpp
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 
19 #include "validatoraccepted_p.h"
20 #include <QStringList>
21 
22 using namespace Cutelyst;
23 
24 ValidatorAccepted::ValidatorAccepted(const QString &field, const Cutelyst::ValidatorMessages &messages) :
25  ValidatorRule(*new ValidatorAcceptedPrivate(field, messages))
26 {
27 
28 }
29 
31 {
32 
33 }
34 
36 {
37  ValidatorReturnType result;
38 
39  if (Q_LIKELY(ValidatorAccepted::validate(value(params)))) {
40  result.value.setValue<bool>(true);
41  } else {
42  result.errorMessage = validationError(c);
43  result.value.setValue<bool>(false);
44  qCDebug(C_VALIDATOR, "ValidatorAccepted: Validation failed for field %s at %s::%s.", qPrintable(field()), qPrintable(c->controllerName()), qPrintable(c->actionName()));
45  }
46 
47  return result;
48 }
49 
50 bool ValidatorAccepted::validate(const QString &value)
51 {
52  bool ret = true;
53  static const QStringList l({QStringLiteral("yes"), QStringLiteral("on"), QStringLiteral("1"), QStringLiteral("true")});
54  ret = l.contains(value, Qt::CaseInsensitive);
55  return ret;
56 }
57 
58 QString ValidatorAccepted::genericValidationError(Cutelyst::Context *c, const QVariant &errorData) const
59 {
60  QString error;
61  Q_UNUSED(errorData)
62  const QString _label = label(c);
63  if (_label.isEmpty()) {
64  error = c->translate("Cutelyst::ValidatorAccepted", "Has to be accepted.");
65  } else {
66  //: %1 will be replaced by the field label
67  error = c->translate("Cutelyst::ValidatorAccepted", "“%1” has to be accepted.");
68  }
69  return error;
70 }
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::ValidatorRule::value
QString value(const ParamsMultiMap &params) const
Returns the value of the field from the input params.
Definition: validatorrule.cpp:41
Cutelyst::ValidatorRule::label
QString label(Context *c) const
Returns the human readable field label used for generic error messages.
Definition: validatorrule.cpp:58
Cutelyst::ValidatorRule::validationError
QString validationError(Context *c, const QVariant &errorData=QVariant()) const
Returns a descriptive error message if validation failed.
Definition: validatorrule.cpp:72
Cutelyst::Context
The Cutelyst Context.
Definition: context.h:50
Cutelyst::ValidatorRule
Base class for all validator rules.
Definition: validatorrule.h:292
Cutelyst::ValidatorAccepted::~ValidatorAccepted
~ValidatorAccepted() override
Deconstructs the accepted validator.
Definition: validatoraccepted.cpp:30
Cutelyst::ValidatorRule::field
QString field() const
Returns the name of the field to validate.
Definition: validatorrule.cpp:39
Cutelyst::ValidatorAccepted::genericValidationError
QString genericValidationError(Context *c, const QVariant &errorData=QVariant()) const override
Creates a generic error message.
Definition: validatoraccepted.cpp:58
Cutelyst::Context::translate
QString translate(const char *context, const char *sourceText, const char *disambiguation=nullptr, int n=-1) const
Definition: context.cpp:473
Cutelyst::ValidatorReturnType
Contains the result of a single input parameter validation.
Definition: validatorrule.h:62
Cutelyst::ValidatorAccepted::validate
static bool validate(const QString &value)
Returns true if the value is yes, on, 1, or true.
Definition: validatoraccepted.cpp:50
Cutelyst
The Cutelyst namespace holds all public Cutelyst API.
Definition: Mainpage.dox:7
Cutelyst::ValidatorReturnType::value
QVariant value
Definition: validatorrule.h:64
Cutelyst::ValidatorAccepted::ValidatorAccepted
ValidatorAccepted(const QString &field, const ValidatorMessages &messages=ValidatorMessages())
Constructs a new accepted validator.
Definition: validatoraccepted.cpp:24
Cutelyst::ValidatorReturnType::errorMessage
QString errorMessage
Definition: validatorrule.h:63