Cutelyst  3.5.0
validatorboolean.cpp
1 /*
2  * SPDX-FileCopyrightText: (C) 2017-2022 Matthias Fehring <mf@huessenbergnetz.de>
3  * SPDX-License-Identifier: BSD-3-Clause
4  */
5 
6 #include "validatorboolean_p.h"
7 #include <QStringList>
8 
9 using namespace Cutelyst;
10 
11 ValidatorBoolean::ValidatorBoolean(const QString &field, const ValidatorMessages &messages, const QString &defValKey) :
12  ValidatorRule(*new ValidatorBooleanPrivate(field, messages, defValKey))
13 {
14 }
15 
17 {
18 }
19 
21 {
22  ValidatorReturnType result;
23 
24  const QString v = value(params);
25 
26  if (!v.isEmpty()) {
27  static const QStringList lt({QStringLiteral("1"), QStringLiteral("true"), QStringLiteral("on")});
28  static const QStringList lf({QStringLiteral("0"), QStringLiteral("false"), QStringLiteral("off")});
29  if (lt.contains(v, Qt::CaseInsensitive)) {
30  result.value.setValue<bool>(true);
31  } else if (lf.contains(v, Qt::CaseInsensitive)) {
32  result.value.setValue<bool>(false);
33  } else {
34  result.errorMessage = validationError(c);
35  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()));
36  }
37  } else {
38  defaultValue(c, &result, "ValidatorBoolean");
39  }
40 
41  return result;
42 }
43 
45 {
46  QString error;
47  Q_UNUSED(errorData)
48  const QString _label = label(c);
49  if (_label.isEmpty()) {
50  error = c->translate("Cutelyst::ValidatorBoolean", "Can not be interpreted as boolean value.");
51  } else {
52  //: %1 will be replaced by the field label
53  error = c->translate("Cutelyst::ValidatorBoolean", "The value in the “%1” field can not be interpreted as a boolean value.").arg(_label);
54  }
55  return error;
56 }
57 
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:38
~ValidatorBoolean() override
Deconstructs the validator.
bool isEmpty() const const
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:471
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.
void setValue(const T &value)
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.
QString field() const
Returns the name of the field to validate.
Contains the result of a single input parameter validation.
Definition: validatorrule.h:49
QString arg(qlonglong a, int fieldWidth, int base, QChar fillChar) const const
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 ...