Cutelyst  2.13.0
validatorrequiredunlessstash.cpp
1 /*
2  * Copyright (C) 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 "validatorrequiredunlessstash_p.h"
20 
21 using namespace Cutelyst;
22 
23 ValidatorRequiredUnlessStash::ValidatorRequiredUnlessStash(const QString &field, const QString &stashKey, const QVariantList &stashValues, const ValidatorMessages &messages) :
24  ValidatorRule(* new ValidatorRequiredUnlessStashPrivate(field, stashKey, stashValues, messages))
25 {
26 }
27 
29 {
30 }
31 
33 {
34  ValidatorReturnType result;
35 
37 
38  if (d->stashKey.isEmpty() || d->stashValues.empty()) {
40  qCWarning(C_VALIDATOR, "ValidatorRequiredUnlessStash: 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 QVariant sv = c->stash(d->stashKey);
44  if (!d->stashValues.contains(sv)) {
45  if (!v.isEmpty()) {
46  result.value.setValue<QString>(v);
47  } else {
48  result.errorMessage = validationError(c);
49  }
50  } else {
51  if (!v.isEmpty()) {
52  result.value.setValue<QString>(v);
53  }
54  }
55  }
56 
57  return result;
58 }
59 
60 QString ValidatorRequiredUnlessStash::genericValidationError(Context *c, const QVariant &errorData) const
61 {
62  QString error;
63  Q_UNUSED(errorData)
64  const QString _label = label(c);
65  if (_label.isEmpty()) {
66  error = c->translate("Cutelyst::ValidatorRequiredUnlessStash", "This is required.");
67  } else {
68  //: %1 will be replaced by the field label
69  error = c->translate("Cutelyst::ValidatorRequiredUnlessStash", "The “%1” field is required.").arg(_label);
70  }
71  return error;
72 }
Cutelyst::ValidatorRequiredUnlessStash
The field under validation must be present and not emptly unless the content of a stash key is equal ...
Definition: validatorrequiredunlessstash.h:47
Cutelyst::ParamsMultiMap
QMap< QString, QString > ParamsMultiMap
Definition: paramsmultimap.h:36
Cutelyst::ValidatorMessages
Stores custom error messages and the input field label.
Definition: validatorrule.h:144
Cutelyst::ValidatorRule::value
QString value(const ParamsMultiMap &params) const
Returns the value of the field from the input params.
Definition: validatorrule.cpp:41
Cutelyst::ValidatorRule::label
QString label(Context *c) const
Returns the human readable field label used for generic error messages.
Definition: validatorrule.cpp:58
Cutelyst::ValidatorRule::validationError
QString validationError(Context *c, const QVariant &errorData=QVariant()) const
Returns a descriptive error message if validation failed.
Definition: validatorrule.cpp:72
Cutelyst::Context
The Cutelyst Context.
Definition: context.h:50
Cutelyst::ValidatorRule
Base class for all validator rules.
Definition: validatorrule.h:292
Cutelyst::ValidatorRule::field
QString field() const
Returns the name of the field to validate.
Definition: validatorrule.cpp:39
Cutelyst::Context::translate
QString translate(const char *context, const char *sourceText, const char *disambiguation=nullptr, int n=-1) const
Definition: context.cpp:473
Cutelyst::ValidatorRequiredUnlessStash::~ValidatorRequiredUnlessStash
~ValidatorRequiredUnlessStash() override
Deconstructs the required unless stash validator.
Definition: validatorrequiredunlessstash.cpp:28
Cutelyst::ValidatorReturnType
Contains the result of a single input parameter validation.
Definition: validatorrule.h:62
Cutelyst::ValidatorRequiredUnlessStash::ValidatorRequiredUnlessStash
ValidatorRequiredUnlessStash(const QString &field, const QString &stashKey, const QVariantList &stashValues, const ValidatorMessages &messages=ValidatorMessages())
Constructs a new required unless stash validator.
Definition: validatorrequiredunlessstash.cpp:23
Cutelyst::ValidatorRequiredUnlessStash::validate
ValidatorReturnType validate(Context *c, const ParamsMultiMap &params) const override
Performs the validation and returns the result.
Definition: validatorrequiredunlessstash.cpp:32
Cutelyst
The Cutelyst namespace holds all public Cutelyst API.
Definition: Mainpage.dox:7
Cutelyst::ValidatorReturnType::value
QVariant value
Definition: validatorrule.h:64
Cutelyst::ValidatorRequiredUnlessStash::genericValidationError
QString genericValidationError(Context *c, const QVariant &errorData=QVariant()) const override
Returns a generic error message if validation failed.
Definition: validatorrequiredunlessstash.cpp:60
Cutelyst::ValidatorReturnType::errorMessage
QString errorMessage
Definition: validatorrule.h:63
Cutelyst::ValidatorRule::validationDataError
QString validationDataError(Context *c, const QVariant &errorData=QVariant()) const
Returns an error message if any validation data is missing or invalid.
Definition: validatorrule.cpp:132
Cutelyst::Context::stash
void stash(const QVariantHash &unite)
Definition: context.h:558