Cutelyst  2.3.0
validatorrequiredunless.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 "validatorrequiredunless_p.h"
20 
21 using namespace Cutelyst;
22 
23 ValidatorRequiredUnless::ValidatorRequiredUnless(const QString &field, const QString &otherField, const QStringList &otherValues, const Cutelyst::ValidatorMessages &messages) :
24  ValidatorRule(*new ValidatorRequiredUnlessPrivate(field, otherField, otherValues, messages))
25 {
26 }
27 
29 {
30 }
31 
33 {
34  ValidatorReturnType result;
35 
36  Q_D(const ValidatorRequiredUnless);
37 
38  if (d->otherField.isEmpty() || d->otherValues.empty()) {
40  qCWarning(C_VALIDATOR, "ValidatorRequiredUnless: invalid validation data for field %s at %s::%s", qPrintable(field()), qPrintable(c->controllerName()), qPrintable(c->actionName()));
41  } else {
42  const QString v = value(params);
43  const QString ov = trimBefore() ? params.value(d->otherField).trimmed() : params.value(d->otherField);
44  if (!d->otherValues.contains(ov)) {
45  if (!v.isEmpty()) {
46  result.value.setValue<QString>(v);
47  } else {
48  result.errorMessage = validationError(c);
49  qCDebug(C_VALIDATOR, "ValidatorRequiredUnless: Validation failed for field %s at %s::%s", qPrintable(field()), qPrintable(c->controllerName()), qPrintable(c->actionName()));
50  }
51  } else {
52  if (!v.isEmpty()) {
53  result.value.setValue<QString>(v);
54  }
55  }
56  }
57 
58  return result;
59 }
60 
61 QString ValidatorRequiredUnless::genericValidationError(Context *c, const QVariant &errorData) const
62 {
63  QString error;
64  Q_UNUSED(errorData)
65  const QString _label = label(c);
66  if (_label.isEmpty()) {
67  error = c->translate("Cutelyst::ValidatorRequiredUnless", "This is required.");
68  } else {
69  error = c->translate("Cutelyst::ValidatorRequiredUnless", "You must fill in the “%1” field.").arg(_label);
70  }
71  return error;
72 }
QMap< QString, QString > ParamsMultiMap
ValidatorRequiredUnless(const QString &field, const QString &otherField, const QStringList &otherValues, const ValidatorMessages &messages=ValidatorMessages())
Constructs a new required unless validator.
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.
The field under validation must be present and not empty unless the other field is equal to any value...
The Cutelyst Context.
Definition: context.h:50
bool trimBefore() const
Returns true if the field value should be trimmed before validation.
QString translate(const char *context, const char *sourceText, const char *disambiguation=nullptr, int n=-1) const
Definition: context.cpp:414
QString validationDataError(Context *c, const QVariant &errorData=QVariant()) const
Returns an error message if any validation data is missing or invalid.
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.
QString genericValidationError(Context *c, const QVariant &errorData=QVariant()) const override
Returns a generic error message if validation failed.
~ValidatorRequiredUnless()
Deconstructs the required unless 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
ValidatorReturnType validate(Context *c, const ParamsMultiMap &params) const override
Performs the validation and returns the result.