Dokumentace třídy Httpd::ControllerTicketFiles

Manipulace se soubory ticketů ...

#include <controllerticketfiles.h>

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

Veřejné metody
	ControllerTicketFiles (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 soubory ticketů

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
"user": 2,                              // Uživatel, klíč v tabulce users
"date": "2020-06-01T00:00:00.000",      // Datum zavedení
"ticket": 2,                            // Ticket, klíč v tabulce tickets
"name":"logo.png",                      // Jméno souboru
"type":"image/png","user":1,            // Content-Typy soubor 
"content":"iVBORw0KGgodr9ncLps2nfX..."  // Obsah, base64
}

Definice je uvedena na řádku 50 v souboru controllerticketfiles.h.

Dokumentace konstruktoru a destruktoru

ControllerTicketFiles()

ControllerTicketFiles::ControllerTicketFiles

(

HobrasoftHttpd::HttpConnection *

parent

)

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

                                                                                 : AbstractController(parent) {
}

Dokumentace členských funkcí

serviceIdDelete()

void ControllerTicketFiles::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 51 v souboru controllerticketfiles.cpp.

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

serviceIdGet()

void ControllerTicketFiles::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 controllerticketfiles.cpp.

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

serviceIdPost()

void ControllerTicketFiles::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 46 v souboru controllerticketfiles.cpp.

                                                                                                                                           {
    serviceIdPut(request, response, data);
}

serviceIdPut()

void ControllerTicketFiles::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 controllerticketfiles.cpp.

                                                                                                                                          {
    serviceOK(request, response, putKey(db()->save(Dbt::TicketFiles::fromMap(data))));
}

serviceList()

void ControllerTicketFiles::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 controllerticketfiles.cpp.

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

---

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

• httpd/controllerticketfiles.h
• httpd/controllerticketfiles.cpp