Dokumentace třídy Httpd::ControllerTicketStatus

Manipulace se stavy ticketů ...

#include <controllerticketstatus.h>

Diagram dědičnosti pro třídu Httpd::ControllerTicketStatus:

Veřejné metody
	ControllerTicketStatus (HobrasoftHttpd::HttpConnection *parent)
Veřejné metody dědí se z Httpd::AbstractController
	AbstractController (HobrasoftHttpd::HttpConnection *parent)
	Konstruktor.
virtual void	service (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response)
	Obsluha požadavku.
void	setCheckId (bool x)
	Nastavuje kontrolu položky ID v datech při PUT a POST.
void	setAuthorizer (RequestAuthorizer *authorizer)
AuthenticatedUser *	authenticatedUser () const
bool	checkId () const
	Vrací stav kontroly položky ID v datech při PUT a POST.
Db::Database *	db ()

Chráněné metody
void	serviceList (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response) Q_DECL_OVERRIDE
	Měl by poslat v odpovědi kompletní seznam všech objektů ve třídě a ukončit se.
void	serviceIdGet (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QString &id) Q_DECL_OVERRIDE
	Pošle odpověď na požadavek konkrétního ID metodou GET.
void	serviceIdPut (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QVariantMap &data) Q_DECL_OVERRIDE
	Pošle odpověď na požadavek konkrétního ID metodou PUT - obvykle vloží nový objekt nebo přepíše existující objekt.
void	serviceIdPost (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QVariantMap &data) Q_DECL_OVERRIDE
	Pošle odpověď na požadavek konkrétního ID metodou PUT - obvykle vloží nový objekt nebo přepíše existující objekt.
void	serviceIdDelete (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QString &id) Q_DECL_OVERRIDE
	Pošle odpověď na požadavek konkrétního ID metodou DELETE - obvykle objekt smaže.
Chráněné metody dědí se z Httpd::AbstractController
virtual bool	exists (const QString &id)
	Kontrola existence zadaného ID.
virtual bool	exists (HobrasoftHttpd::HttpRequest *request, const QString &id)
	Kontrola existence zadaného ID.
virtual void	serviceOK (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QVariant &data=QVariant())
	Pošle odpověď 200 OK.
virtual void	serviceError (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, int code, const QString &error, const QVariantMap &data)
	Pošle chybovou odpověď
virtual void	serviceEvents (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response)
	Pošle v odpovědi kompletní seznam všech objektů ve třídě a následně
virtual void	serviceIdEvents (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QString &id)
	Pošle v odpovědi proud událostí spojených se všemi objekty ve třídě
virtual void	serviceEvent (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QVariant &data)
	Pošle do otevřeného proudu událostí jednu událost.
virtual bool	isAuthorized (Security::Permissions::Permission)
HobrasoftHttpd::HttpRequest *	request () const
	Vrací ukazatel na aktuální request.
HobrasoftHttpd::HttpConnection *	connection () const
	Vrací ukazatel na aktuální connection.

Další zděděné členy
Statické chráněné metody dědí se z Httpd::AbstractController
static QVariantMap	putKey (const QVariant &key)

Detailní popis

Manipulace se stavy ticketů

Každý ticket může obsahovat několik za sebou následujících stavů, například: nový, v řešení, vyřešeno, vyfakturováno, zavřeno. Při změně celého ticketu může být vhodnější použít Httpd::ControllerTicketsVw

Implementované metody:

• get
• put, post
• del

Parametry

ticket	- Vybere záznamy k zadanému ticketu, na konci URL musí být zadané ID alespoň ve formě lomítka (ignoruje se)
all	- Normálně jsou v seznamu pouze otevřené tickety, parametrem all = true lze vypsat všechny tickety, vždy však pouze tickety s přístupem přihlášeného uživatele

Struktura jednoho záznamu:

{
"id": 9,                                // Primární klíč, při insertu se může změnit
"date": "2020-06-01T00:00:00.000",      // datum zavedení
"status": "NEW",                        // Status, klíč v tabulce statuses
"description": "Práce zahájeny",        // Popis
"ticket": 2,                            // Ticket, klíč v tabulce tickets
"user": 2,                              // Uživatel, klíč v tabulce users
}

Definice je uvedena na řádku 52 v souboru controllerticketstatus.h.

Dokumentace konstruktoru a destruktoru

ControllerTicketStatus()

ControllerTicketStatus::ControllerTicketStatus

(

HobrasoftHttpd::HttpConnection *

parent

)

Definice je uvedena na řádku 14 v souboru controllerticketstatus.cpp.

                                                                                   : AbstractController(parent) {
}

Dokumentace členských funkcí

serviceIdDelete()

void ControllerTicketStatus::serviceIdDelete ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response, const QString & id )

protectedvirtual

Pošle odpověď na požadavek konkrétního ID metodou DELETE - obvykle objekt smaže.

Defaultní implementace posílá chybu 501 Not Implemented

Reimplementuje stejnojmenný prvek z Httpd::AbstractController.

Definice je uvedena na řádku 61 v souboru controllerticketstatus.cpp.

                                                                                                                                        {
    db()->remove(Dbt::TicketStatus(id));
    serviceOK(request, response);
}

serviceIdGet()

void ControllerTicketStatus::serviceIdGet ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response, const QString & id )

protectedvirtual

Pošle odpověď na požadavek konkrétního ID metodou GET.

Defaultní implementace posílá chybu 501 Not Implemented

Reimplementuje stejnojmenný prvek z Httpd::AbstractController.

Definice je uvedena na řádku 24 v souboru controllerticketstatus.cpp.

                                                                                                                                      {
    bool all = QVariant(request->parameter("all")).toBool();
    int ticket = QVariant(request->parameter("ticket")).toInt();
    auto list = (ticket > 0)
                    ? db()->ticketStatus(ticket, all)
                    : (id.isEmpty())
                        ? db()->ticketStatus(all)
                        : db()->ticketStatus(id.toInt())
                        ;
    if (list.isEmpty()) {
        serviceError(request, response, 404, "not-found", "NotFound");
        return;
        }
    serviceOK(request, response, list[0].toMap());
}

serviceIdPost()

void ControllerTicketStatus::serviceIdPost ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response, const QVariantMap & data )

protectedvirtual

Pošle odpověď na požadavek konkrétního ID metodou PUT - obvykle vloží nový objekt nebo přepíše existující objekt.

Defaultní implementace posílá chybu 501 Not Implemented

Reimplementuje stejnojmenný prvek z Httpd::AbstractController.

Definice je uvedena na řádku 56 v souboru controllerticketstatus.cpp.

                                                                                                                                            {
    serviceIdPut(request, response, data);
}

serviceIdPut()

void ControllerTicketStatus::serviceIdPut ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response, const QVariantMap & data )

protectedvirtual

Pošle odpověď na požadavek konkrétního ID metodou PUT - obvykle vloží nový objekt nebo přepíše existující objekt.

Defaultní implementace posílá chybu 501 Not Implemented

Reimplementuje stejnojmenný prvek z Httpd::AbstractController.

Definice je uvedena na řádku 41 v souboru controllerticketstatus.cpp.

                                                                                                                                           {
    if (data.contains("ticket")) {
        serviceOK(request, response, putKey(db()->save(Dbt::TicketStatus::fromMap(data))));
        return;
        }
 
    if (data.contains("categories")) {
        serviceOK(request, response, putKey(db()->save(Dbt::AppendStatuses::fromMap(data))));
        return;
        }
 
    serviceError(request, response, 400, "bad-format", "JSON has bad format, it must contain 'ticket' or 'categories' fields");
}

serviceList()

void ControllerTicketStatus::serviceList ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response )

protectedvirtual

Měl by poslat v odpovědi kompletní seznam všech objektů ve třídě a ukončit se.

Defaultní implementace posílá chybu 501 Not Implemented

Reimplementuje stejnojmenný prvek z Httpd::AbstractController.

Definice je uvedena na řádku 18 v souboru controllerticketstatus.cpp.

                                                                                                                  {
    bool all = QVariant(request->parameter("all")).toBool();
    serviceOK(request, response, toList(db()->ticketStatus(all)));
}

---

Dokumentace pro tuto třídu byla vygenerována z následujících souborů:

• httpd/controllerticketstatus.h
• httpd/controllerticketstatus.cpp