PHPackages crackle/crackle - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [HTTP & Networking](/categories/http) 4. / 5. crackle/crackle ActiveLibrary[HTTP & Networking](/categories/http) crackle/crackle =============== Crackle is a powerful yet easy to use object-oriented HTTP client. v2.6.0(10y ago)413031MITPHPPHP >=5.3.0 Since Apr 9Pushed 10y ago2 watchersCompare [ Source](https://github.com/gebn/Crackle)[ Packagist](https://packagist.org/packages/crackle/crackle)[ Docs](https://github.com/gebn/Crackle)[ RSS](/packages/crackle-crackle/feed)WikiDiscussions master Synced 3d ago READMEChangelog (10)DependenciesVersions (7)Used By (1) Crackle [![License](https://camo.githubusercontent.com/f48f8d6cf609f5b181b9c3218a85175fe8a5809c7ea400347f39697a5d55065d/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c75652e7376673f7374796c653d666c6174)](LICENSE) [![Stars](https://camo.githubusercontent.com/5da59b93d9aac122af3faff778f74062cde878c4a985ea8ba2476e06b8a7ae78/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f6765626e2f637261636b6c652e7376673f7374796c653d666c6174)](https://github.com/gebn/Crackle/stargazers) [![Issues](https://camo.githubusercontent.com/a27d72e882950abb11eb17e9648f7a7de39474fdcbad244b4b066de7028b63cc/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f6765626e2f637261636b6c652e7376673f7374796c653d666c6174)](https://github.com/gebn/Crackle/issues) ================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================ [](#crackle---) Crackle is a powerful yet easy to use object-oriented HTTP client for PHP. Features -------- [](#features) - GET, POST, HEAD, PUT, DELETE - Request authentication (basic, digest, NTLM) - Proxy support (with optional basic and NTLM authentication) - Easy header management - Fine-grained field handling - Simultaneous processing of multiple requests - Request callbacks - Many more... Dependencies ------------ [](#dependencies) ### Required [](#required) - PHP 5.3.0+ - cURL extension ### Optional [](#optional) - Fileinfo extension (enables automatic detection of file MIME types) Getting Started --------------- [](#getting-started) ### A simple GET request [](#a-simple-get-request) Below is a minimal example showing how to issue a GET request to GitHub's API, and print out the response content body. ``` require_once 'Crackle.php'; use \Crackle\Requests\GETRequest; use \Crackle\Exceptions\RequestException; try { $request = new GETRequest('https://api.github.com/users/gebn'); echo $request->getResponse()->getBody(); } catch (RequestException $e) { echo $e->getMessage(); } ``` There are several things to note: - You only ever need to require `Crackle.php`; Crackle has an autoloader, which will take care of other includes for you. - All types of request (`GET`, `POST` etc.) are stored in the `\Crackle\Requests` namespace. They have names of the form `Request.php` to make them easy to find. - Requests have a `fire()` method which is called implicitly the first time `getResponse()` is called on a request. - Crackle will throw a `RequestException` on failure, so all requests should be wrapped in a try/catch statement. All exceptions thrown by Crackle (excluding those in the SPL) extend `CrackleException` and are located in the `\Crackle\Exceptions` namespace. - `getResponse()` returns an object containing the final URL, response headers, HTTP status code, and of course content body. ### A POST request [](#a-post-request) This example introduces fields. Crackle uses the following terminology: - **GET fields** are referred to as ***parameters*** - **POST fields** are referred to as ***variables*** - **POST files** are referred to as ***files*** For example, by calling `getParameters()`, you are retrieving the object containing fields that will be appended to the request's URL. ``` require_once 'Crackle.php'; use \Crackle\Requests\POSTRequest; use \Crackle\Requests\Files\POSTFile; use \Crackle\Exceptions\RequestException; try { $request = new POSTRequest('http://pastebin.com/api/api_post.php'); $request->getParameters()->set('api_request', 'beer'); $request->getVariables()->set('api_option', 'paste'); $request->getFiles()->set('api_file', POSTFile::factory('leaked-credentials.txt')); $request->fire(); } catch (RequestException $e) { echo $e->getMessage(); } ``` Crackle allows you to arbitrarily nest all three types of field depending on your needs using PHP's array syntax: ``` $variables = $request->getVariables(); $variables->set('details', array( 'name' => array( 'forename' => 'George', 'surname' => 'Brighton'), 'address' => 'nice try')); // you can also add to the hierarchy later, or build it up manually: $variables->set('details[name][nickname]', 'brighty'); ``` ### Adding authentication and proxies [](#adding-authentication-and-proxies) All types of request can be authenticated and proxied: ``` require_once 'Crackle.php'; use \Crackle\Requests\PUTRequest; use \Crackle\Requests\Files\PUTFile; use \Crackle\Proxies\SOCKS5Proxy; use \Crackle\Authentication\Methods\BasicCredentials; use \Crackle\Authentication\Methods\NTLMCredentials; $request = new PUTRequest('https://api.trello.com/1/cards/OeU7nvW6'); // Basic, Digest and NTLM are supported $request->setCredentials(new BasicCredentials('', '')); $file = new PUTFile(); // PUTFile also has a factory($path) method $file->setContent('virtual file content'); $file->setMimeType('text/plain'); // optional $request->setFile($file); $proxy = new SOCKS5Proxy('10.11.12.13'); // HTTP proxies are also supported $proxy->setCredentials( // N.B. proxy (not request) credentials new NTLMCredentials('', '')); // Basic and NTLM supported $request->setProxy($proxy); ``` Hopefully you're now getting an idea of how the various different components of Crackle fit together. For additional examples, see the contents of `/Examples`. Advanced Use ------------ [](#advanced-use) ### Parallel requests with callbacks [](#parallel-requests-with-callbacks) Crackle includes a `Requester` class in the default namespace which has a single purpose: to fire off requests simultaneously. Its use is highly recommended if you're dealing with multiple requests - performance gains can be significant. So significant in fact, that Crackle was started because I wanted an easier way to manage parallel requests. The name *Crackle* comes from a fire crackling, in the same way you could imagine Crackle firing off multiple requests. A callback is a function that can be attached to a Crackle request. As soon as the request finishes, regardless of success or failure, the callback is executed. It is passed the original request object as its only argument. This sample will fire off requests to BBC News and Twitter, and announce when each has finished (it won't always be in the same order): ``` require_once 'Crackle.php'; use \Crackle\Requests\GETRequest; use \Crackle\Requests\POSTRequest; use \Crackle\Requester; $bbc = new GETRequest('http://www.bbc.co.uk/news/'); $bbc->setCallback(function(GETRequest $request) { echo 'BBC request finished', "\n"; }); $twitter = new POSTRequest('https://api.twitter.com/1.1/statuses/update'); $twitter->setCallback(function(POSTRequest $request) { echo 'Twitter request finished', "\n"; }); $requester = new Requester(); $requester->queue($bbc); $requester->queue($twitter); $requester->fireAll(); ``` Callbacks can be deployed elsewhere, but they come into their own when used with simultaneous requests. They allow you to do processing while Crackle is still sending other requests in the queue. You can even add new requests to the queue from within callbacks while it is still being processed! Crackle can fire all types of request simultaneously - `PUTRequest` and `DELETERequest` won't fight if they're put in the same queue. When requests are fired via `Requester`, they do not throw an exception on failure. Instead, you can check `$request->succeeded()` or `$request->failed()` inside the callback. A call to `$request->getResponse()` will throw a `ResponseException` if the request did not succeed - so check it did first! ### Accessing the cURL handle [](#accessing-the-curl-handle) Crackle allows direct manipulation of a request's underlying cURL handle. This can be retrieved by calling `getHandle()` on its object: ``` $request = new GETRequest('https://example.com'); curl_setopt($request->getHandle(), CURLOPT_SSL_VERIFYPEER, false); ``` N.B. Some options are set by Crackle immediately before sending the request, so overriding them manually will have no effect. Development ----------- [](#development) Crackle is on Trello! [Click here](https://trello.com/crackle) to visit the organisation's homepage. To see what's in the pipeline, have a peek at the [Development](https://trello.com/b/91q94waP/development) board! If you discover a bug, first check Trello to make sure I'm not already aware of it. If you can't see a match, please open a [new issue](https://github.com/gebn/Crackle/issues/new) on GitHub. Contributing ------------ [](#contributing) Please feel free to fork Crackle, create a feature branch, and send me a pull request! Licence ------- [](#licence) Crackle is released under the MIT Licence - see the LICENSE file for details. For more information about how this allows you to use the library, see the [Wikipedia article](http://en.wikipedia.org/wiki/MIT_License). ### Health Score 30 — LowBetter than 64% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity16 Limited adoption so far Community12 Small or concentrated contributor base Maturity62 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~137 days Recently: every ~170 days Total 6 Last Release 3732d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/b78de457acf6c6a1a5921ebb42c827b2444e902db4885e7a016af6ee2eb1512f?d=identicon)[gebn](/maintainers/gebn) --- Top Contributors [![gebn](https://avatars.githubusercontent.com/u/2334407?v=4)](https://github.com/gebn "gebn (144 commits)") --- Tags httprequestcurl ### Embed Badge ![Health badge](/badges/crackle-crackle/health.svg) ``` [![Health](https://phpackages.com/badges/crackle-crackle/health.svg)](https://phpackages.com/packages/crackle-crackle) ``` ### Alternatives [aplus/http-client Aplus Framework HTTP Client Library 2161.6M1](/packages/aplus-http-client)[pear/http_request2 Provides an easy way to perform HTTP requests. 764.2M48](/packages/pear-http-request2)[pdeans/http PSR-7 cURL HTTP client with support for PSR-17 HTTP factories. 1466.2k3](/packages/pdeans-http) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)