cakephp/http

CakePHP HTTP client and PSR7/15 middleware libraries

5.1.4 2024-12-06 14:53 UTC

Requires

• php: >=8.1
• cakephp/core: ^5.1
• cakephp/event: ^5.1
• cakephp/utility: ^5.1
• composer/ca-bundle: ^1.5
• laminas/laminas-diactoros: ^3.3
• laminas/laminas-httphandlerrunner: ^2.6
• psr/http-client: ^1.0.2
• psr/http-factory: ^1.1
• psr/http-message: ^1.1 || ^2.0
• psr/http-server-handler: ^1.0.2
• psr/http-server-middleware: ^1.0.2

Requires (Dev)

• cakephp/cache: ^5.1
• cakephp/console: ^5.1
• cakephp/i18n: ^5.1
• cakephp/orm: ^5.1
• paragonie/csp-builder: ^3.0

Suggests

• cakephp/cache: To use cache session storage
• cakephp/orm: To use database session storage
• paragonie/csp-builder: To use CspMiddleware

Provides

• psr/http-client-implementation: ^1.0
• psr/http-factory-implementation: ^1.1
• psr/http-server-handler-implementation: ^1.0
• psr/http-server-middleware-implementation: ^1.0

MIT

• CakePHP Community

• http
• cakephp
• psr-7
• psr-17
• psr-15
• psr-18

README

CakePHP Http Library

This library provides a PSR-15 Http middleware server, PSR-7 Request and Response objects, and a PSR-18 Http Client. Together these classes let you handle incoming server requests and send outgoing HTTP requests.

Using the Http Client

Sending requests is straight forward. Doing a GET request looks like:

use Cake\Http\Client;

$http = new Client();

// Simple get
$response = $http->get('http://example.com/test.html');

// Simple get with querystring
$response = $http->get('http://example.com/search', ['q' => 'widget']);

// Simple get with querystring & additional headers
$response = $http->get('http://example.com/search', ['q' => 'widget'], [
  'headers' => ['X-Requested-With' => 'XMLHttpRequest'],
]);

To learn more read the Http Client documentation.

Using the Http Server

The Http Server allows an HttpApplicationInterface to process requests and emit responses. To get started first implement the Cake\Http\HttpApplicationInterface A minimal example could look like:

namespace App;

use Cake\Core\HttpApplicationInterface;
use Cake\Http\MiddlewareQueue;
use Cake\Http\Response;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;

class Application implements HttpApplicationInterface
{
    /**
     * Load all the application configuration and bootstrap logic.
     *
     * @return void
     */
    public function bootstrap(): void
    {
        // Load configuration here. This is the first
        // method Cake\Http\Server will call on your application.
    }

    /**
     * Define the HTTP middleware layers for an application.
     *
     * @param \Cake\Http\MiddlewareQueue $middlewareQueue The middleware queue to set in your App Class
     * @return \Cake\Http\MiddlewareQueue
     */
    public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue
    {
        // Add middleware for your application.
        return $middlewareQueue;
    }

    /**
     * Handle incoming server request and return a response.
     *
     * @param \Psr\Http\Message\ServerRequestInterface $request The request
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function handle(ServerRequestInterface $request): ResponseInterface
    {
        return new Response(['body'=>'Hello World!']);
    }
}

Once you have an application with some middleware. You can start accepting requests. In your application's webroot, you can add an index.php and process requests:

<?php
// in webroot/index.php
require dirname(__DIR__) . '/vendor/autoload.php';

use App\Application;
use Cake\Http\Server;

// Bind your application to the server.
$server = new Server(new Application());

// Run the request/response through the application and emit the response.
$server->emit($server->run());

You can then run your application using PHP's built in webserver:

php -S localhost:8765 -t ./webroot ./webroot/index.php

For more information on middleware, consult the documentation