Request Reference

query

Read URL query parameters:

$page   = $request->query('page', 1);
$search = $request->query('q');
$all    = $request->query();          // all query params as array

json

Read JSON request body:

$body  = $request->json();            // entire body as array
$name  = $request->json('name');      // single key
$page  = $request->json('page', 1);  // with default

form

Read application/x-www-form-urlencoded or multipart/form-data fields:

$name  = $request->form('name');
$all   = $request->form();            // all fields as array

body

Raw request body as string:

$raw = $request->body();

all

All input merged (query + body):

$input = $request->all();
$name  = $request->all('name');

has

Check if a key is present (query or body):

if ($request->has('search')) {
    // ...
}

files

Access uploaded files:

$file  = $request->file('avatar');        // single file
$files = $request->files();              // all files

// File properties
$file->name();        // original filename
$file->tmpPath();     // temporary file path
$file->size();        // size in bytes
$file->mimeType();    // detected MIME type
$file->extension();   // file extension

// Move to permanent location
$file->moveTo(storage_path('uploads/' . $file->name()));

header

Read request headers:

$type  = $request->header('Content-Type');
$auth  = $request->header('Authorization');
$all   = $request->headers();              // all headers as array

method

$method = $request->method(); // GET, POST, PUT, PATCH, DELETE, ...

path

$path = $request->path(); // /api/users/42

params (route parameters)

Route parameters are injected directly as typed method arguments:

$app->get('/users/{id}', function (Request $req, int $id) {
    // $id is cast to int automatically
});

ip

$ip = $request->ip(); // client IP address

isJson

Check if the request has a JSON body:

if ($request->isJson()) {
    $data = $request->json();
}

isMethod

if ($request->isMethod('POST')) {
    // ...
}

bearerToken

Extract Bearer token from the Authorization header:

$token = $request->bearerToken(); // returns string or null