Cutelyst  2.3.0
validatorpresent.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 "validatorpresent_p.h"
20 
21 using namespace Cutelyst;
22 
23 ValidatorPresent::ValidatorPresent(const QString &field, const Cutelyst::ValidatorMessages &messages) :
24  ValidatorRule(*new ValidatorPresentPrivate(field, messages))
25 {
26 }
27 
29 {
30 }
31 
33 {
34  ValidatorReturnType result;
35 
36  if (!params.contains(field())) {
37  result.errorMessage = validationError(c);
38  qCDebug(C_VALIDATOR, "ValidatorPresent: Validation failed for field %s at %s::%s: field was not found in the input data", qPrintable(field()), qPrintable(c->controllerName()), qPrintable(c->actionName()));
39  } else {
40  result.value.setValue<QString>(value(params));
41  }
42 
43  return result;
44 }
45 
46 QString ValidatorPresent::genericValidationError(Context *c, const QVariant &errorData) const
47 {
48  QString error;
49  Q_UNUSED(errorData)
50  const QString _label = label(c);
51  if (_label.isEmpty()) {
52  error = c->translate("Cutelyst::ValidatorPresent", "Has to be present in input data.");
53  } else {
54  error = c->translate("Cutelyst::ValidatorPresent", "The “%1” field was not found in the input data.").arg(_label);
55  }
56  return error;
57 }
QMap< QString, QString > ParamsMultiMap
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 Cutelyst Context.
Definition: context.h:50
QString translate(const char *context, const char *sourceText, const char *disambiguation=nullptr, int n=-1) const
Definition: context.cpp:414
ValidatorPresent(const QString &field, const ValidatorMessages &messages=ValidatorMessages())
Constructs a new present validator.
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.
~ValidatorPresent()
Deconstructs the present validator.
QString value(const ParamsMultiMap &params) const
Returns the value of the field from the input params.
ValidatorReturnType validate(Context *c, const ParamsMultiMap &params) const override
Performs the validation and returns the result.
QString field() const
Returns the name of the field to validate.
Contains the result of a single input parameter validation.
Definition: validatorrule.h:62
QString genericValidationError(Context *c, const QVariant &errorData=QVariant()) const override
Returns a generic error message if validation failed.