Dokumentace třídy Httpd::ControllerDoorEmployees

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

Veřejné metody
	ControllerDoorEmployees (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	serviceGet (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, int door, int employee)
void	servicePut (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, int door, const QVariantMap &data)
void	serviceDelete (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, int door, int employee)
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.

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 8 v souboru controllerdooremployees.h.

Dokumentace konstruktoru a destruktoru

ControllerDoorEmployees()

ControllerDoorEmployees::ControllerDoorEmployees

(

HobrasoftHttpd::HttpConnection *

parent

)

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

    : AbstractController(parent) {}

Dokumentace členských funkcí

service()

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

protectedvirtual

Obsluha požadavku.

Reimplementuje stejnojmenný prvek z Httpd::AbstractController.

Definice je uvedena na řádku 13 v souboru controllerdooremployees.cpp.

{
    static const QRegularExpression re("^/api/v1/doors/(\\d+)/employees(?:/(\\d+))?/?$");
    auto m = re.match(request->path());
    if (!m.hasMatch()) {
        serviceError(request, response, 405, "bad-request", "Invalid request");
        return;
    }
 
    int door = m.captured(1).toInt();
    int employee = m.captured(2).isEmpty() ? -1 : m.captured(2).toInt();
 
    if (request->method() == "GET") {
        serviceGet(request, response, door, employee);
        return;
    }
 
    if (request->method() == "PUT") {
        bool ok = false;
        QVariantMap data = JSON::data(request->body(), &ok).toMap();
        if (!ok) {
            serviceError(request, response, 400, "bad-request", "Could not parse JSON data");
            return;
        }
        servicePut(request, response, door, data);
        return;
    }
 
    if (request->method() == "DELETE") {
        if (employee <= 0) {
            serviceError(request, response, 400, "bad-request", "Employee id required");
            return;
        }
        serviceDelete(request, response, door, employee);
        return;
    }
 
    serviceError(request, response, 405, "bad-request", "Invalid request");
}

serviceDelete()

void ControllerDoorEmployees::serviceDelete ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response, int door, int employee )

protected

Definice je uvedena na řádku 78 v souboru controllerdooremployees.cpp.

{
    db()->remove(Dbt::EmployeeCanOpenDoor(employee, door));
    serviceOK(request, response);
}

serviceGet()

void ControllerDoorEmployees::serviceGet ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response, int door, int employee )

protected

Definice je uvedena na řádku 53 v souboru controllerdooremployees.cpp.

{
    Dbt::EmployeeCanOpenDoor filter;
    filter.door = door;
    filter.employee = employee > 0 ? employee : 0;
    auto list = db()->employeeCanOpenDoor(filter);
    if (employee > 0) {
        if (list.isEmpty()) {
            serviceError(request, response, 404, "not-found", "NotFound");
            return;
        }
        serviceOK(request, response, list.first().toMap());
    } else {
        serviceOK(request, response, toList(list));
    }
}

servicePut()

void ControllerDoorEmployees::servicePut ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response, int door, const QVariantMap & data )

protected

Definice je uvedena na řádku 70 v souboru controllerdooremployees.cpp.

{
    QVariantMap d = data;
    d["door"] = door;
    db()->save(Dbt::EmployeeCanOpenDoor::fromMap(d));
    serviceOK(request, response);
}

---

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

• httpd/controllerdooremployees.h
• httpd/controllerdooremployees.cpp