Dokumentace třídy Httpd::ControllerTimesheet

Nastartování nebo zastavení pracovního výkazu. ...

#include <controllertimesheet.h>

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

Veřejné metody
	ControllerTimesheet (HobrasoftHttpd::HttpConnection *parent)
Veřejné metody dědí se z Httpd::AbstractController
	AbstractController (HobrasoftHttpd::HttpConnection *parent)
	Konstruktor.
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	service (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response) Q_DECL_OVERRIDE
	Obsluha požadavku.
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	serviceList (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response)
	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	serviceIdGet (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QString &id)
	Pošle odpověď na požadavek konkrétního ID metodou GET.
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.

Privátní metody
void	serviceStart (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, int id)
void	serviceStop (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, int id)
void	serviceToggle (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, int id)

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

Detailní popis

Nastartování nebo zastavení pracovního výkazu.

Na server se posílá příkaz (start, stop, toggle) a id ticketu, který se má spustit:

/api/v1/timesheet/start/<id>

Běžící výkazy lze zastavit hromadně jediným příkazem. Start a Toggle takto ovládat nelze! Chceme-li zastavit všechny běžící pracovní výkazy, je možné použít příkaz:

/api/v1/timesheet/stop/all

Implementuje metody:

• get

Vrací jednoduchou informaci:

[{
"id": 34,                                   // ID záznamu, primární klíč
"user": 2,                                  // ID uživatele, kterému záznam patří
"ticket": 1,                                // ID ticketu
"date_from": "2020-08-13T15:12:25.619",     // Začátek pracovního úkonu
"date_to": null                             // Konec pracovního úkonu, pokud ticket běží, vrací null
}]

Příklady:

Nastartování zastaveného ticketu s id 111 (stejný efekt by měl u zastaveného ticketu příkaz toggle):

/api/v1/timesheet/start/1

[{
"ticket": 1111, 
"id": 34, 
"user": 2, 
"date_from": "2020-10-26T07:22:00",
"date_to": null                     // Běží, není ukončeno
}]

Zastavení běžícího ticketu s id 111 (stejný efekt by měl u běžícího ticketu příkaz toggle):

/api/v1/timesheet/stop/1

[{
"ticket": 1111, 
"id": 34, 
"user": 2, 
"date_from": "2020-10-26T07:22:00",
"date_to": "2020-10-26T07:24:12"    // Neběží, je ukončeno
}]

Další nastartování zastaveného ticketu s id 111, id záznamu v tabulce timesheets má novou hodnotu, tj. v tabulce přibyl nový záznam:

/api/v1/timesheet/start/1

[{
"ticket": 1111, 
"id": 35,                           // Nový záznam
"user": 2, 
"date_from": "2020-10-26T07:22:00",
"date_to": null                     // Běží, není ukončeno
}]

Pokud dojde k pokusu nastartovat běžící záznam, nebo k pokusu ukončit zastavený záznam, vrací chybu, HTTP status 409 Conflict. Chyba může znamenat, že ticket je spuštěný z jiného klienta. U příkazu toggle k chybě nedochází, může ale dojít ke konfliktům mezi různými klienty:

/api/v1/start/1

[{
"ticket": 1111, 
"id": 35,                           // Nový záznam
"ok": false,
"error": "running"
"reason": "The ticket is running already"
}]

Definice je uvedena na řádku 117 v souboru controllertimesheet.h.

Dokumentace konstruktoru a destruktoru

ControllerTimesheet()

ControllerTimesheet::ControllerTimesheet

(

HobrasoftHttpd::HttpConnection *

parent

)

Definice je uvedena na řádku 15 v souboru controllertimesheet.cpp.

                                                                             : AbstractController(parent) {
}

Dokumentace členských funkcí

service()

void ControllerTimesheet::service ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response )

protectedvirtual

Obsluha požadavku.

Reimplementuje stejnojmenný prvek z Httpd::AbstractController.

Definice je uvedena na řádku 98 v souboru controllertimesheet.cpp.

                                                                                                          {
    QStringList parts = request->path().split("/");
    PDEBUG << parts;
    parts.removeFirst();
    parts.removeFirst();
    parts.removeFirst();
 
    while (parts.size() == 3) {
        bool ok;
        QString sid = parts[2];
        int id = sid.toInt(&ok);
        if (sid == "all") { ok = true; id = 0; }
        if (!ok) { break; }
 
        if (parts[0] == "timesheet" && parts[1] == "start") {
            serviceStart(request, response, id);
            return;
            }
 
        if (parts[0] == "timesheet" && parts[1] == "stop") {
            serviceStop(request, response, id);
            return;
            }
 
        if (parts[0] == "timesheet" && parts[1] == "toggle") {
            serviceToggle(request, response, id);
            return;
            }
 
        break;
        }
 
    serviceError(request, response, 405, "bad-request", "Invalid request");
}

serviceStart()

void ControllerTimesheet::serviceStart ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response, int id )

private

Definice je uvedena na řádku 19 v souboru controllertimesheet.cpp.

                                                                                                                       {
    PDEBUG;
    QList<Dbt::TicketTimesheets> list1 = db()->runningTimesheets(id);
    if (!list1.isEmpty()) {
        QVariantMap item = list1[0].toMap();
        item.remove("created");
        item.remove("modified");
        item["ok"] = false;
        item["error"] = "conflict";
        item["reason"] = "Timesheet is already started";
        serviceError(request, response, 409, "conflict", item);
        return;
        }
 
    QList<Dbt::TicketTimesheets> list2 = db()->startTimesheet(id);
    if (list2.isEmpty()) {
        serviceError(request, response, 400, "error", "Timesheet could not be started");
        return;
        }
 
    QVariantMap item = list2[0].toMap();
    item.remove("created");
    item.remove("modified");
    serviceOK(request, response, item);
}

serviceStop()

void ControllerTimesheet::serviceStop ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response, int id )

private

Definice je uvedena na řádku 46 v souboru controllertimesheet.cpp.

                                                                                                                      {
    PDEBUG << id;
    QList<Dbt::TicketTimesheets> list1 = db()->runningTimesheets(id);
    if (list1.isEmpty()) {
        QVariantMap item;
        item["ok"] = false;
        item["error"] = "conflict";
        item["reason"] = "No running timesheet found";
        serviceError(request, response, 409, "conflict", item);
        return;
        }
 
    QVariantList items;
    for (int i=0; i<list1.size(); i++) {
        int xid = list1[0].ticket.toInt();
        PDEBUG << "Stopping" << xid;
        QList<Dbt::TicketTimesheets> list2 = db()->stopTimesheet(xid);
        if (list2.isEmpty()) { 
            PDEBUG << "error, Some timesheets could not be stopped, id: " << xid;
            continue; 
            }
 
        QVariantMap item = list2[0].toMap();
        item.remove("created");
        item.remove("modified");
        items << item;
        }
 
    if (items.isEmpty()) {
        serviceError(request, response, 400, "error", "Some timesheets could not be stopped");
        return;
        }
 
    serviceOK(request, response, items);
}

serviceToggle()

void ControllerTimesheet::serviceToggle ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response, int id )

private

Definice je uvedena na řádku 83 v souboru controllertimesheet.cpp.

                                                                                                                        {
    PDEBUG;
    QList<Dbt::TicketTimesheets> list2 = db()->toggleTimesheet(id);
    if (list2.isEmpty()) {
        serviceError(request, response, 400, "error", "Timesheet could not be toggled");
        return;
        }
 
    QVariantMap item = list2[0].toMap();
    item.remove("created");
    item.remove("modified");
    serviceOK(request, response, item);
}

---

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

• httpd/controllertimesheet.h
• httpd/controllertimesheet.cpp