Dokumentace třídy Httpd::ControllerWorkCalendar

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

Veřejné metody
	ControllerWorkCalendar (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.
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.
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.
void	serviceGenerate (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, int year)
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	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

Definice je uvedena na řádku 13 v souboru controllerworkcalendar.h.

Dokumentace konstruktoru a destruktoru

ControllerWorkCalendar()

ControllerWorkCalendar::ControllerWorkCalendar

(

HobrasoftHttpd::HttpConnection *

parent

)

Definice je uvedena na řádku 8 v souboru controllerworkcalendar.cpp.

: AbstractController(parent) { }

Dokumentace členských funkcí

service()

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

protectedvirtual

Obsluha požadavku.

Reimplementuje stejnojmenný prvek z Httpd::AbstractController.

Definice je uvedena na řádku 10 v souboru controllerworkcalendar.cpp.

                                                                                                             {
    QStringList parts = request->path().split("/");
    parts.removeFirst();
    parts.removeFirst();
    parts.removeFirst();
 
    if (parts.size() == 3 && parts[0] == "workcalendar" && parts[1] == "generate") {
        bool ok = false;
        int year = parts[2].toInt(&ok);
        if (!ok) {
            serviceError(request, response, 400, "bad-request", "Invalid year");
            return;
        }
        serviceGenerate(request, response, year);
        return;
    }
 
    AbstractController::service(request, response);
}

serviceGenerate()

void ControllerWorkCalendar::serviceGenerate ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response, int year )

protected

Definice je uvedena na řádku 58 v souboru controllerworkcalendar.cpp.

                                                                                                                               {
    Q_UNUSED(request);
    db()->generateWorkCalendar(year);
    serviceOK(request, response);
}

serviceIdDelete()

void ControllerWorkCalendar::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 52 v souboru controllerworkcalendar.cpp.

                                                                                                                                        {
    QDate date = QDate::fromString(id, "yyyy-MM-dd");
    db()->remove(Dbt::WorkCalendar(date));
    serviceOK(request, response);
}

serviceIdGet()

void ControllerWorkCalendar::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 35 v souboru controllerworkcalendar.cpp.

                                                                                                                                     {
    QDate date = QDate::fromString(id, "yyyy-MM-dd");
    if (!date.isValid()) { serviceError(request, response, 404, "not-found", "NotFound"); return; }
    auto list = db()->workCalendar(date);
    if (list.isEmpty()) { serviceError(request, response, 404, "not-found", "NotFound"); return; }
    serviceOK(request, response, list.first().toMap());
}

serviceIdPost()

void ControllerWorkCalendar::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 48 v souboru controllerworkcalendar.cpp.

                                                                                                                                            {
    serviceIdPut(request, response, data);
}

serviceIdPut()

void ControllerWorkCalendar::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 43 v souboru controllerworkcalendar.cpp.

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

serviceList()

void ControllerWorkCalendar::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 30 v souboru controllerworkcalendar.cpp.

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

---

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

• httpd/controllerworkcalendar.h
• httpd/controllerworkcalendar.cpp