dumbo/README.md

Dumbo

A lightweight, friendly PHP framework for HTTP — inspired by Hono.

Install

composer require notrab/dumbo

Quickstart

Here's a basic example of how it works!

<?php

use Dumbo\Dumbo;

$app = new Dumbo();

$app->get("/", function ($c) {
    return $c->json('Hello Dumbo!');
});

$app->run();

Routing

<?php

$app->get('/users', function($c) { /* ... */ });
$app->post('/users', function($c) { /* ... */ });
$app->put('/users/:id', function($c) { /* ... */ });
$app->delete('/users/:id', function($c) { /* ... */ });

Params

<?php

$app->get('/users/:id', function($c) {
    $id = $c->req->param('id');

    return $c->json(['id' => $id]);
});

Nested

<?php

$nestedApp = new Dumbo();

$nestedApp->get('/nested', function($c) {
    return $c->text('This is a nested route');
});

$app->route('/prefix', $nestedApp);

Context

<?php

$app->get('/', function($c) {
    $pathname = $c->req->pathname();
    $routePath = $c->req->routePath();
    $queryParam = $c->req->query('param');
    $tags = $c->req->queries('tags');
    $body = $c->req->body();
    $userAgent = $c->req->header('User-Agent');
});

Response

<?php

return $c->json(['key' => 'value']);
return $c->text('Hello, World!');
return $c->html('<h1>Hello, World!</h1>');
return $c->redirect('/new-url');

Middleware

<?php

$app->use(function($c, $next) {
    $response = $next($c);

    return $response;
});

Helpers

Bearer Auth

curl -H 'Authorization: Bearer mysupersecret' http://localhost:8000/api

<?php

$app = new Dumbo();
$protectedRoutes = new Dumbo();

$token = "mysupersecret";

$protectedRoutes->use(BearerAuth::bearer($token));

// You can add custom failure message as a second argument.😍 It's optional.
$protectedRoutes->use(BearerAuth::bearer($token, 'Unauthorized request.'));

$protectedRoutes->get("/", function ($c) {
    return $c->json(["message" => "Welcome to the protected routes!"]);
});

$app->route("/api", $protectedRoutes);

Exception handlers

<?php

$app = new Dumbo();

$app->post('/', function(Context $c) {
    if (!checkAuthStatus()) {
        throw new HTTPException(401, 'Unauthorized');
    }
});

Or with a custom response:

<?php

$app = new Dumbo();

$app->post('/', function(Context $c) {
    if (!doSomething()) {
        $customResponse = $c->html('<h1>Something went wrong</h1>', 404);
        throw new HTTPException(404, 'Something went wrong', $customResponse);
    }
});