cutelyst  3.9.1
A C++ Web Framework built on top of Qt, using the simple approach of Catalyst (Perl) framework.
validatorrequiredunless.cpp
1 /*
2  * SPDX-FileCopyrightText: (C) 2017-2022 Matthias Fehring <mf@huessenbergnetz.de>
3  * SPDX-License-Identifier: BSD-3-Clause
4  */
5 
6 #include "validatorrequiredunless_p.h"
7 
8 using namespace Cutelyst;
9 
11  const QString &otherField,
12  const QStringList &otherValues,
13  const Cutelyst::ValidatorMessages &messages)
14  : ValidatorRule(*new ValidatorRequiredUnlessPrivate(field, otherField, otherValues, messages))
15 {
16 }
17 
19 {
20 }
21 
23  const ParamsMultiMap &params) const
24 {
25  ValidatorReturnType result;
26 
27  Q_D(const ValidatorRequiredUnless);
28 
29  if (d->otherField.isEmpty() || d->otherValues.empty()) {
31  qCWarning(C_VALIDATOR,
32  "ValidatorRequiredUnless: invalid validation data for field %s at %s::%s",
33  qPrintable(field()),
34  qPrintable(c->controllerName()),
35  qPrintable(c->actionName()));
36  } else {
37  const QString v = value(params);
38  const QString ov =
39  trimBefore() ? params.value(d->otherField).trimmed() : params.value(d->otherField);
40  if (!d->otherValues.contains(ov)) {
41  if (!v.isEmpty()) {
42  result.value.setValue(v);
43  } else {
44  result.errorMessage = validationError(c);
45  qCDebug(C_VALIDATOR,
46  "ValidatorRequiredUnless: Validation failed for field %s at %s::%s",
47  qPrintable(field()),
48  qPrintable(c->controllerName()),
49  qPrintable(c->actionName()));
50  }
51  } else {
52  if (!v.isEmpty()) {
53  result.value.setValue(v);
54  }
55  }
56  }
57 
58  return result;
59 }
60 
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  //: %1 will be replaced by the field label
70  error = c->translate("Cutelyst::ValidatorRequiredUnless", "The “%1” field is required.")
71  .arg(_label);
72  }
73  return error;
74 }
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.
<Cutelyst/Plugins/Utils/validatorrequiredunless.h>
~ValidatorRequiredUnless() override
Deconstructs the required unless validator.
The Cutelyst Context.
Definition: context.h:38
bool isEmpty() const const
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:490
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.
void setValue(const T &value)
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.
QString arg(qlonglong a, int fieldWidth, int base, QChar fillChar) const const
QString field() const
Returns the name of the field to validate.
Contains the result of a single input parameter validation.
Definition: validatorrule.h:49
ValidatorReturnType validate(Context *c, const ParamsMultiMap &params) const override
Performs the validation and returns the result.
const T value(const Key &key, const T &defaultValue) const const