The Request Object: In-Depth¶

The Request object is your primary tool for interacting with incoming data. Beyond the basic methods like post() and get(), it offers several powerful shortcuts and helpers to make your code more concise and readable.

Universal Access

The Request object provides unified access to all types of input data.

Universal Parameter Access¶

Instead of checking post(), get(), and json() separately, you can use the Request object like a function to get a parameter from any input source ($_REQUEST). This is the quickest way to access data.

<?php
use PhpSPA\Http\Request;

function SearchHandler(Request $request) {
   // This will get the 'term' value whether it comes from
   // a GET query string (?term=...) or a POST form field.
   $searchTerm = $request('term');

   // ... perform search logic ...
   return "<p>Showing results for: <strong>{$searchTerm}</strong></p>";
}

Flexible Input

This will get the 'term' value whether it comes from a GET query string (?term=...) or a POST form field.

Handling File Uploads¶

Accessing uploaded files is simple with the ->files() method.

All FilesSpecific File

Calling $request->files() with no arguments returns an array of all uploaded files.

<?php

$allFiles = $request->files();

Calling it with a name returns the data for that specific file input.

<?php

$avatarFile = $request->files('avatar');

File Upload Handler

<?php

use PhpSPA\Http\Request;

function ProfileUpload(Request $request) {
   if ($request->isMethod('POST')) {
      $avatarFile = $request->files('avatar');

      if ($avatarFile && $avatarFile['error'] === UPLOAD_ERR_OK) {
         // A file was successfully uploaded
         $tmpName = $avatarFile['tmp_name'];
         $fileName = basename($avatarFile['name']);
         move_uploaded_file($tmpName, "uploads/{$fileName}");

         return "<p>File uploaded successfully!</p>";
      }
   }

   return <<<HTML
      <form method="POST" enctype="multipart/form-data">
         <input type="file" name="avatar">
         <button type="submit">Upload</button>
      </form>
   HTML;
}

Secure Upload

Always validate file uploads on the server-side before processing them.

Request Helper Methods¶

The Request object provides several helper methods for common operations:

Method Checking¶

<?php

// Check if request method matches
if ($request->isMethod('POST')) {
    // Handle POST request
}

// Get the current HTTP method
$method = $request->method(); // 'GET', 'POST', 'PUT', etc.

Protocol & Security¶

<?php

// Check if request is over HTTPS
if ($request->isHttps()) {
    // Secure connection
}

// Get server protocol
$protocol = $request->protocol(); // 'HTTP/1.1', 'HTTP/2', etc.

// Get request URI
$uri = $request->getUri(); // '/api/users/123'

Request Metadata¶

<?php

// Get request timestamp
$timestamp = $request->requestTime();

// Get content type
$contentType = $request->contentType(); // 'application/json'

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

// Check if AJAX/XHR request
if ($request->isAjax()) {
    // Handle async request
}

// Get referrer URL
$referrer = $request->referrer();

API Reference¶

Method	Returns	Description
`isMethod(string $method)`	`bool`	Checks if request method matches
`method()`	`string`	Returns HTTP method (GET, POST, etc.)
`isHttps()`	`bool`	Checks if request is over HTTPS
`protocol()`	`?string`	Returns server protocol
`getUri()`	`string`	Returns request URI
`requestTime()`	`int`	Returns Unix timestamp of request
`contentType()`	`?string`	Returns Content-Type header value
`ip()`	`string`	Returns client IP address
`isAjax()`	`bool`	Checks if request is AJAX/XHR
`referrer()`	`?string`	Returns referring URL