Skip to main content

Response Helpers

Routes can return values that are automatically handled.

Return Arrays (Auto-converted to JSON)​

use PhpCompatible\Router\Router;

Router::get('/api/users', function() {
    return array(
        'users' => array(
            array('id' => 1, 'name' => 'Alice'),
            array('id' => 2, 'name' => 'Bob'),
        )
    );
});
// Output: {"users":[{"id":1,"name":"Alice"},{"id":2,"name":"Bob"}]}

Return Strings​

Router::get('/hello', function() {
    return 'Hello World';
});

Router::get('/page', function() {
    return '<html><body><h1>Page</h1></body></html>';
});

JsonResponse Objects​

use PhpCompatible\Router\JsonResponse;

Router::get('/api/users', function() {
    return JsonResponse::response(HTTP_OK, array('users' => array()));
});

Router::post('/api/users', function() {
    $data = json_body();
    $user = create_user($data);
    return JsonResponse::response(HTTP_CREATED, array('user' => $user));
});

Router::get('/api/users/:id', function() {
    $user = find_user($_GET[':id']);
    if (!$user) {
        return JsonResponse::response(HTTP_NOT_FOUND, array('error' => 'User not found'));
    }
    return JsonResponse::response(HTTP_OK, array('user' => $user));
});

Available JsonResponse Methods​

JsonResponse::response(HTTP_OK, $data);              // 200
JsonResponse::response(HTTP_CREATED, $data);          // 201
JsonResponse::response(HTTP_NO_CONTENT);             // 204
JsonResponse::response(HTTP_BAD_REQUEST, $data);       // 400
JsonResponse::response(HTTP_UNAUTHORIZED, $data);     // 401
JsonResponse::response(HTTP_FORBIDDEN, $data);        // 403
JsonResponse::response(HTTP_NOT_FOUND, $data);         // 404
JsonResponse::response(HTTP_INTERNAL_SERVER_ERROR, $data);      // 500

HtmlResponse Objects​

use PhpCompatible\Router\HtmlResponse;

Router::get('/page', function() {
    return HtmlResponse::response(HTTP_OK, '<h1>Hello</h1>');
});

Router::get('/view', function() {
    $html = render_template('page.php', array(
        'title' => 'My Page',
        'user' => get_current_user()
    ));
    return HtmlResponse::response(HTTP_OK, $html);
});
Templates

For a blazing fast PHP templating solution, see php-compatible/templates.

File Downloads​

Router::get('/export/csv', function() {
    $csv = "id,name,email\n";
    foreach (get_all_users() as $user) {
        $csv .= "{$user['id']},{$user['name']},{$user['email']}\n";
    }
    download_csv($csv, 'users.csv');
});

Router::get('/export/json', function() {
    $data = array('users' => get_all_users());
    download_json($data, 'users.json');
});

Router::get('/files/:id', function() {
    $file = get_file($_GET[':id']);
    download_file($file['path'], $file['name']);
});

Response Headers​

Router::get('/api/data', function() {
    response_header('X-Custom-Header', 'value');
    response_header('Cache-Control', 'max-age=3600');
    return array('cached' => true);
});