Cutelyst  2.3.0
validatorboolean.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 "validatorboolean_p.h"
20 #include <QStringList>
21 
22 using namespace Cutelyst;
23 
24 ValidatorBoolean::ValidatorBoolean(const QString &field, const ValidatorMessages &messages, const QString &defValKey) :
25  ValidatorRule(*new ValidatorBooleanPrivate(field, messages, defValKey))
26 {
27 }
28 
30 {
31 }
32 
34 {
35  ValidatorReturnType result;
36 
37  const QString v = value(params);
38 
39  if (!v.isEmpty()) {
40  static const QStringList lt({QStringLiteral("1"), QStringLiteral("true"), QStringLiteral("on")});
41  static const QStringList lf({QStringLiteral("0"), QStringLiteral("false"), QStringLiteral("off")});
42  if (lt.contains(v, Qt::CaseInsensitive)) {
43  result.value.setValue<bool>(true);
44  } else if (lf.contains(v, Qt::CaseInsensitive)) {
45  result.value.setValue<bool>(false);
46  } else {
47  result.errorMessage = validationError(c);
48  qCDebug(C_VALIDATOR, "ValidatorBoolean: The value %s of field %s in %s::%s can not be interpreted as boolean.", qPrintable(v), qPrintable(field()), qPrintable(c->controllerName()), qPrintable(c->actionName()));
49  }
50  } else {
51  defaultValue(c, &result, "ValidatorBoolean");
52  }
53 
54  return result;
55 }
56 
57 QString ValidatorBoolean::genericValidationError(Cutelyst::Context *c, const QVariant &errorData) const
58 {
59  QString error;
60  Q_UNUSED(errorData);
61  const QString _label = label(c);
62  if (_label.isEmpty()) {
63  error = c->translate("Cutelyst::ValidatorBoolean", "Can not be interpreted as boolean value.");
64  } else {
65  error = c->translate("Cutelyst::ValidatorBoolean", "The value in the “%1” field can not be interpreted as a boolean value.").arg(_label);
66  }
67  return error;
68 }
69 
QMap< QString, QString > ParamsMultiMap
QString validationError(Context *c, const QVariant &errorData=QVariant()) const
Returns a descriptive error message if validation failed.
Stores custom error messages and the input field label.
QString genericValidationError(Context *c, const QVariant &errorData=QVariant()) const override
Returns a generic error message if validation failed.
The Cutelyst Context.
Definition: context.h:50
ValidatorReturnType validate(Context *c, const ParamsMultiMap &params) const override
Performs the validation and returns the result.
QString translate(const char *context, const char *sourceText, const char *disambiguation=nullptr, int n=-1) const
Definition: context.cpp:414
The Cutelyst namespace holds all public Cutelyst API.
Definition: Mainpage.dox:7
Base class for all validator rules.
QString label(Context *c) const
Returns the human readable field label used for generic error messages.
QString value(const ParamsMultiMap &params) const
Returns the value of the field from the input params.
ValidatorBoolean(const QString &field, const ValidatorMessages &messages=ValidatorMessages(), const QString &defValKey=QString())
Constructs a new validator.
~ValidatorBoolean()
Deconstructs the validator.
QString field() const
Returns the name of the field to validate.
Contains the result of a single input parameter validation.
Definition: validatorrule.h:62
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 ...