https://github.com/cakephp/http
[READONLY] HTTP client and server libraries
https://github.com/cakephp/http
Last synced: 6 months ago
JSON representation
[READONLY] HTTP client and server libraries
- Host: GitHub
- URL: https://github.com/cakephp/http
- Owner: cakephp
- License: other
- Created: 2019-10-12T19:38:18.000Z (over 6 years ago)
- Default Branch: 4.x
- Last Pushed: 2025-06-21T03:36:41.000Z (7 months ago)
- Last Synced: 2025-06-21T04:29:09.298Z (7 months ago)
- Language: PHP
- Size: 1.37 MB
- Stars: 5
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://packagist.org/packages/cakephp/http)
[](LICENSE.txt)
# 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:
```php
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](https://book.cakephp.org/4/en/core-libraries/httpclient.html).
## 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:
```php
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
emit($server->run());
```
You can then run your application using PHP's built in webserver:
```bash
php -S localhost:8765 -t ./webroot ./webroot/index.php
```
For more information on middleware, [consult the
documentation](https://book.cakephp.org/4/en/controllers/middleware.html)