Cutelyst  2.5.0
validatorrequiredif.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 "validatorrequiredif_p.h"
20 
21 using namespace Cutelyst;
22 
23 ValidatorRequiredIf::ValidatorRequiredIf(const QString &field, const QString &otherField, const QStringList &otherValues, const Cutelyst::ValidatorMessages &messages) :
24  ValidatorRule(*new ValidatorRequiredIfPrivate(field, otherField, otherValues, messages))
25 {
26 }
27 
29 {
30 }
31 
33 {
34  ValidatorReturnType result;
35 
36  Q_D(const ValidatorRequiredIf);
37 
38  if (d->otherField.isEmpty() || d->otherValues.empty()) {
40  qCWarning(C_VALIDATOR, "ValidatorRequiredIf: 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.errorMessage = validationError(c);
47  qCDebug(C_VALIDATOR, "ValidatorRequiredIf: Validation failed for field %s at %s::%s", qPrintable(field()), qPrintable(c->controllerName()), qPrintable(c->actionName()));
48  } else {
49  result.value.setValue<QString>(v);
50  }
51  } else {
52  if (!v.isEmpty()) {
53  result.value.setValue<QString>(v);
54  }
55  }
56  }
57 
58  return result;
59 }
60 
61 QString ValidatorRequiredIf::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::ValidatorRequiredIf", "This is required.");
68  } else {
69  error = c->translate("Cutelyst::ValidatorRequiredIf", "You must fill in the “%1” field.").arg(_label);
70  }
71  return error;
72 }
QMap< QString, QString > ParamsMultiMap
QString validationError(Context *c, const QVariant &errorData=QVariant()) const
Returns a descriptive error message if validation failed.
ValidatorRequiredIf(const QString &field, const QString &otherField, const QStringList &otherValues, const ValidatorMessages &messages=ValidatorMessages())
Constructs a new required if validator.
Stores custom error messages and the input field label.
ValidatorReturnType validate(Context *c, const ParamsMultiMap &params) const override
Performs the validation and returns the result.
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
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.
The field under validation must be present and not empty if the other field is equal to any value in ...
QString field() const
Returns the name of the field to validate.
Contains the result of a single input parameter validation.
Definition: validatorrule.h:62
~ValidatorRequiredIf()
Deconstructs the required if validator.