Manipulace se šablonami stavů ...

#include <controllerstatustemplates.h>

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

Veřejné metody
	ControllerStatusTemplates (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
	Pošle chybovou odpověď
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.
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	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	serviceIdDelete (HobrasoftHttpd::HttpRequest request, HobrasoftHttpd::HttpResponse response, const QString &id)
	Pošle odpověď na požadavek konkrétního ID metodou DELETE - obvykle objekt smaže.
virtual void	serviceIdPut (HobrasoftHttpd::HttpRequest request, HobrasoftHttpd::HttpResponse response, const QVariantMap &data)
	Pošle odpověď na požadavek konkrétního ID metodou PUT - obvykle vloží nový objekt nebo přepíše existující objekt.
virtual void	serviceIdPost (HobrasoftHttpd::HttpRequest request, HobrasoftHttpd::HttpResponse response, const QVariantMap &data)
	Pošle odpověď na požadavek konkrétního ID metodou PUT - obvykle vloží nový objekt nebo přepíše existující objekt.
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 šablonami stavů

Implementuje metody:

get

Struktura jednoho záznamu

{
"id": 11,                       // Primární klíč
"status": "NEW"                 // Ke kterému stavu se vztahuje
"code": "23409"                 // Kód (zkratka)
"category": "12-23"             // Ke které kategorii se vztahuje
"title": "Nový",                // Popis stavu, v jazyce uživatele
"description": "{cs:'abcd'}",   // Podrobný popis v JSON, více jazyků, uživatel obvykle nevidí
}

Definice je uvedena na řádku 46 v souboru controllerstatustemplates.h.

Dokumentace konstruktoru a destruktoru

◆ ControllerStatusTemplates()

ControllerStatusTemplates::ControllerStatusTemplates ( HobrasoftHttpd::HttpConnection * parent )

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

14 : AbstractController(parent) {

15}

Httpd::AbstractController::AbstractController

AbstractController(HobrasoftHttpd::HttpConnection *parent)

Konstruktor.

Definition abstractcontroller.cpp:20

Dokumentace členských funkcí

◆ serviceIdGet()

void ControllerStatusTemplates::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 23 v souboru controllerstatustemplates.cpp.

                                                                                                                                        {
    auto list = db()->statusTemplates(id.toInt());
    if (list.isEmpty()) {
        serviceError(request, response, 404, "not-found", "NotFound");
        return;
        }
    serviceOK(request, response, list[0].toMap());
}

◆ serviceList()

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

protectedvirtual

Pošle chybovou odpověď

Parametry

code	- chybový kód (například 404)
error	- chybový textový kód
reason	- vysvětlení chyby

Posílá odpověď zformátovanou takto:

Content-Type: application/json
Cache-Control: no-cache,public
 
404 not-found
{ "error" : "not-found", "reason" : "Not found" }

*/ virtual void serviceError (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, int code, const QString& error, const QString& reason);

/**

Pošle chybovou odpověď

Parametry

code	- chybový kód (například 404)
error	- chybový textový kód, píše se do HTTP statutu
reason	- vysvětlení chyby

Posílá odpověď zformátovanou takto:

Content-Type: application/json
Cache-Control: no-cache,public
 
404 text v parametru error
{ ..... }

*/ virtual void serviceError (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, int code, const QString& error, const QVariantMap& data);

/**

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 controllerstatustemplates.cpp.

                                                                                                                     {
    serviceOK(request, response, toList(db()->statusTemplates()));
}

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

httpd/controllerstatustemplates.h
httpd/controllerstatustemplates.cpp

Veřejné metody