cutelyst  3.9.1
A C++ Web Framework built on top of Qt, using the simple approach of Catalyst (Perl) framework.
validatorrequiredifstash.cpp
1 /*
2  * SPDX-FileCopyrightText: (C) 2018-2022 Matthias Fehring <mf@huessenbergnetz.de>
3  * SPDX-License-Identifier: BSD-3-Clause
4  */
5 
6 #include "validatorrequiredifstash_p.h"
7 
8 using namespace Cutelyst;
9 
11  const QString &stashKey,
12  const QVariantList &stashValues,
13  const ValidatorMessages &messages)
14  : ValidatorRule(*new ValidatorRequiredIfStashPrivate(field, stashKey, stashValues, messages))
15 {
16 }
17 
19 {
20 }
21 
23  const ParamsMultiMap &params) const
24 {
25  ValidatorReturnType result;
26 
27  Q_D(const ValidatorRequiredIfStash);
28 
29  if (d->stashKey.isEmpty() || d->stashValues.empty()) {
31  qCWarning(C_VALIDATOR,
32  "ValidatorRequiredIfStash: 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 QVariant sv = c->stash(d->stashKey);
39  if (d->stashValues.contains(sv)) {
40  if (v.isEmpty()) {
41  result.errorMessage = validationError(c);
42  qCDebug(C_VALIDATOR,
43  "ValidatorRequiredIfStash: Validation failed for field %s at %s::%s",
44  qPrintable(field()),
45  qPrintable(c->controllerName()),
46  qPrintable(c->actionName()));
47  } else {
48  result.value.setValue(v);
49  }
50  } else {
51  if (!v.isEmpty()) {
52  result.value.setValue(v);
53  }
54  }
55  }
56 
57  return result;
58 }
59 
61  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::ValidatorRequiredIfStash", "This is required.");
68  } else {
69  //: %1 will be replaced by the field label
70  error = c->translate("Cutelyst::ValidatorRequiredIfStash", "The “%1” field is required.")
71  .arg(_label);
72  }
73  return error;
74 }
QString validationError(Context *c, const QVariant &errorData=QVariant()) const
Returns a descriptive error message if validation failed.
ValidatorReturnType validate(Context *c, const ParamsMultiMap &params) const override
Performs the validation and returns the result.
Stores custom error messages and the input field label.
<Cutelyst/Plugins/Utils/validatorrequiredifstash.h>
The Cutelyst Context.
Definition: context.h:38
void stash(const QVariantHash &unite)
Definition: context.cpp:566
QString genericValidationError(Context *c, const QVariant &errorData=QVariant()) const override
Returns a generic error message if validation failed.
bool isEmpty() const const
QString translate(const char *context, const char *sourceText, const char *disambiguation=nullptr, int n=-1) const
Definition: context.cpp:490
~ValidatorRequiredIfStash() override
Deconstructs the required if validator.
ValidatorRequiredIfStash(const QString &field, const QString &stashKey, const QVariantList &stashValues, const ValidatorMessages &messages=ValidatorMessages())
Constructs a new required if stash validator.
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 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