cakephp/http

4.1.0-beta1 2020-05-15 06:35 UTC

This package is auto-updated.

Last update: 2020-05-24 01:42:44 UTC


README

Total Downloads License

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 would could look like:

namespace App

use Cake\Core\HttpApplicationInterface;
use Cake\Http\MiddlewareQueue;

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 $middleware The middleware queue to set in your App Class
     * @return \Cake\Http\MiddlewareQueue
     */
    public function middleware(MiddlewareQueue $middleware): MiddlewareQueue
    {
        // Add middleware for your application.
        return $middleware;
    }
}

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