Skip to content

Latest commit

 

History

History
93 lines (64 loc) · 3.36 KB

README.md

File metadata and controls

93 lines (64 loc) · 3.36 KB
Raw

Buzz - Scripted HTTP browser

Build Status Latest Version Code Coverage Quality Score Total Downloads Monthly Downloads

Buzz is a lightweight PHP 5.3 library for issuing HTTP requests.

Installation

Package available on Composer.

Install by running:

composer require kriswallsmith/buzz

Usage

This page will just show you the basics, please read the full documentation.

<?php

$browser = new Buzz\Browser();
$response = $browser->get('http://www.google.com');

echo $browser->getLastRequest()."\n";
// $response is an object. 
// You can use $response->getContent() or $response->getHeaders() to get only one part of the response.
echo $response;

You can also use the low-level HTTP classes directly.

<?php

$request = new Buzz\Message\Request('HEAD', '/', 'http://google.com');
$response = new Buzz\Message\Response();

$client = new Buzz\Client\FileGetContents();
$client->send($request, $response);

echo $request;
echo $response;

The Idea of Buzz

Buzz was created by Kris Wallsmith back in 2010. The project grown very popular over the years with more than 7 million downloads.

Since August 2017 Tobias Nyholm is maintaining this library. The idea of Buzz will still be the same, we should have a simple API and mimic browser behavior for easy testing. We should not reinvent the wheel and we should not be as powerful and flexible as other clients (ie Guzzle). We do, however, take performance very seriously.

We do love PSRs and this is a wish list of what PSR we would like to support:

  • PSR-1 (Code style)
  • PSR-2 (Code style)
  • PSR-4 (Auto loading)
  • PSR-7 (HTTP messages)
  • PSR-17 (HTTP factories)
  • PSR-18 (HTTP client)

Backwards Compatibility Promise

We take backwards compatibility very seriously as you should do with any open source project. We strictly follow Semver. Please note that Semver works a bit different prior version 1.0.0. Minor versions prior 1.0.0 are allow to break backwards compatibility.

Being greatly inspired by Symfony's bc promise, we have adopted their method of deprecating classes, interfaces and functions. We also promise that no code or features will be removed before 1.0.0.

Running the tests

To run the test we need to set up a webserver. Using PHP's build in one works perfectly.

vendor/bin/http_test_server > /dev/null 2>&1 &
php -S 127.0.0.1:8080 test/server.php  &
composer test