Http

The Http component models the HTTP request and response: parameter bags, uploaded files, HTML, JSON and redirect responses, and HTTP exceptions. It has no dependency and is used by the kernel, the routing and the controllers.

Request

NeoPHP\Component\Http\Request\Request is injected in a controller action by its type.

public function search(Request $request): Response
{
    $query = $request->query->getString('q');
    $page = $request->query->getInt('page', 1);

    return $this->render('search.html.twig', ['query' => $query, 'page' => $page]);
}

Request::METHODS lists the accepted methods.

Bags

ParameterBag (query, request, attributes, cookies, server) is iterable and countable:

FileBag extends ParameterBag and holds UploadedFile objects (or lists of them).

HeaderBag is case-insensitive: all(), get($name, $default) (first value), getValues($name), set($name, $values, $replace), has(), remove(), HeaderBag::fromServer($server).

Uploaded files

$file = $request->files->get('avatar');

if ($file instanceof UploadedFile && $file->isValid()) {
    $name = $file->move($this->getParameter('kernel.root_path') . '/public/uploads', uniqid() . '.' . $file->getClientOriginalExtension());
}

Responses

$response = new Response('<h1>Hello</h1>', 200, ['X-Custom' => 'value']);
$response->setStatusCode(201);
$response->setHeader('Cache-Control', 'no-cache');
$response->setCookie('theme', 'dark', time() + 3600);

new JsonResponse(['ok' => true]);
new RedirectResponse('/login');

Response:

JsonResponse($data, $status, $headers, $flags) encodes $data (getData(), setData()); JsonResponse::DEFAULT_FLAGS keeps slashes and unicode unescaped. RedirectResponse($url, $status = 302, $headers) sets the Location header (getTargetUrl()).

HTTP service

NeoPHP\Component\Http\Contract\HttpInterface (implemented by HttpManager) can be injected in a service:

Controller helpers

The trait HttpController of AbstractController provides:

return $this->json(['id' => $post->getId()], 201);
return $this->json($post, 200, [], ['groups' => ['read']]);
return $this->redirect('/posts');
throw $this->createNotFoundException('Post {id} not found.', ['id' => $id]);
throw $this->createAccessDeniedException();

json($data, $status = 200, $headers = [], $context = []): when $data contains objects, or when a $context is given, the data is normalized with the Serializer (#[Groups], #[SerializedName], #[Ignore], dates, enums, entities...) before the JsonResponse is built. Arrays of scalars are encoded as before. See the Serializer documentation for the context options.

The trait declares abstract protected function get(string $id): mixed; and abstract protected function has(string $id): bool; (both provided by ContainerController).

To redirect to a route, use redirectToRoute() (see the Routing documentation).

HTTP exceptions

All extend NeoPHP\Component\Exception\FrameworkException (see the Exception documentation):

throw new HttpException(503, 'Maintenance in progress.', ['Retry-After' => '3600']);

Errors are rendered as HTML, or as JSON when the request sends Accept: application/json. With the Api component, API errors can be rendered as RFC 7807 problem details (application/problem+json, see the Api documentation).

Changelog

• v1.24.0 — TooManyRequestsHttpException (429, Retry-After).
• v1.23.0 — json() accepts a serializer context and normalizes objects with the Serializer
• v1.17.x (bugfix) — absolute URLs fall back on getSchemeAndHttpHost() of the request when APP_URL is not set.
• v1.0.0 — Request, Response, JsonResponse, RedirectResponse, bags, uploaded files, HTTP exceptions and JSON errors.