validatorresult.h

/*
 * Copyright (C) 2017-2018 Matthias Fehring <kontakt@buschmann23.de>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
#ifndef CUTELYSTVALIDATORRESULT_H
#define CUTELYSTVALIDATORRESULT_H

#include <Cutelyst/cutelyst_global.h>
#include <QString>
#include <QStringList>
#include <QSharedDataPointer>
#include <QVariantHash>
#include <QJsonObject>

namespace Cutelyst {

class ValidatorResultPrivate;

class CUTELYST_PLUGIN_UTILS_VALIDATOR_EXPORT ValidatorResult {
public:
    ValidatorResult();

    ValidatorResult(const ValidatorResult &other);

    ValidatorResult& operator =(const ValidatorResult &other);

    ~ValidatorResult();

    bool isValid() const;

    void addError(const QString &field, const QString &message);

    QStringList errorStrings() const;

    QHash<QString,QStringList> errors() const;

    QStringList errors(const QString &field) const;

    bool hasErrors(const QString &field) const;

    QJsonObject errorsJsonObject() const;

    QStringList failedFields() const;

    explicit operator bool() const {
        return isValid();
    }

    QVariantHash values() const;

    QVariant value(const QString &field) const;

    void addValue(const QString &field, const QVariant &value);

    QVariantHash extras() const;

    QVariant extra(const QString &field) const;

    void addExtra(const QString &field, const QVariant &extra);

private:
    QSharedDataPointer<ValidatorResultPrivate> d;
};

}

#endif // CUTELYSTVALIDATORRESULT_H