PHPackages modethirteen/hyperplug - 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. modethirteen/hyperplug ActiveLibrary[HTTP & Networking](/categories/http) modethirteen/hyperplug ====================== A PHP library for plugging into HTTP sockets 14.0k1[5 issues](https://github.com/modethirteen/HyperPlug/issues)1PHP Since Sep 12Pushed 3y ago1 watchersCompare [ Source](https://github.com/modethirteen/HyperPlug)[ Packagist](https://packagist.org/packages/modethirteen/hyperplug)[ RSS](/packages/modethirteen-hyperplug/feed)WikiDiscussions main Synced today READMEChangelogDependenciesVersions (1)Used By (1) HyperPlug ========= [](#hyperplug) A PHP library for plugging into HTTP sockets. [![github.com](https://github.com/modethirteen/HyperPlug/workflows/build/badge.svg)](https://github.com/modethirteen/HyperPlug/actions?query=workflow%3Abuild)[![codecov.io](https://camo.githubusercontent.com/15c692cdde612b2d7e50890ff3dd88749f2760fd6e814f5f52e276670e00539c/68747470733a2f2f636f6465636f762e696f2f6769746875622f6d6f6465746869727465656e2f4879706572506c75672f636f7665726167652e7376673f6272616e63683d6d61696e)](https://codecov.io/github/modethirteen/HyperPlug?branch=main)[![Latest Stable Version](https://camo.githubusercontent.com/835744decd855b2999b4577e6e548d40c852b461709900e0cd5168bc853fd294/68747470733a2f2f706f7365722e707567782e6f72672f6d6f6465746869727465656e2f6879706572706c75672f76657273696f6e2e737667)](https://packagist.org/packages/modethirteen/hyperplug)[![Latest Unstable Version](https://camo.githubusercontent.com/2bfd602a9280c67502f2a5d009675f730e634abf77ad7744dd5cf278d56f2baf/68747470733a2f2f706f7365722e707567782e6f72672f6d6f6465746869727465656e2f6879706572706c75672f762f756e737461626c65)](https://packagist.org/packages/modethirteen/hyperplug) - PHP 7.4 (main, 2.x) Installation ------------ [](#installation) Use [Composer](https://getcomposer.org/). There are two ways to add this library to your project. From the composer CLI: ``` ./composer.phar require modethirteen/hyperplug ``` Or add modethirteen/hyperplug to your project's composer.json: ``` { "require": { "modethirteen/hyperplug": "dev-main" } } ``` `dev-main` is the main development branch. If you are using this library in a production environment, it is advised that you use a stable release. Assuming you have setup Composer's autoloader, the library can be found in the `modethirteen\Http\` namespace. Getting Started --------------- [](#getting-started) A quick example: ``` $plug = new Plug(XUri::newFromString('https://api.example.com/v2')) ->withResultParser(new JsonParser()); $result = $plug->at('users', 'bob') ->get(); if($result->isSuccess()) { // great job! echo $result->getVal('body/name'); } ``` Usage ----- [](#usage) ``` // the library allows for programmatic URL construction and parsing $uri = XUri::newFromString('http://api.example.com/v3') // every step in a URL builder returns an immutable XUri object ->withScheme('https') ->at('widgets') ->withQueryParam('xyzzy', 'plugh') ->withQueryParams(QueryParams::newFromArray([ 'bar' => 'qux', 'baz' => 'fred' ])) ->withoutQueryParam('bar'); // QueryParams objects are normally immutable $params = $uri->getQueryParams(); // we can change the data structure of a QueryParams object if we must $params = $params->toMutableQueryParams(); $params->set('baz', 'abc'); // QueryParams are also iterable foreach($params as $param => $value) { $uri = $uri->withReplacedQueryParam($param, $value); } // what does our URL look like now? $result = $uri->toString(); // https://api.example.com/v3/widgets?xyzzy=plugh&baz=abc // we can give our XUri object to a Plug to create a client $plug = new Plug($uri); // like every object in this library, attaching new values or behaviors to plugs is by default immutable // ...and returns a new object reference // add credentials for authorization $plug->withCredentials('franz', 'beckenbauer'); // or a bearer token $plug->withHeader('Authorization', 'Bearer 12345'); // we can add some additional URL path segments and query parameters that weren't part of the constructing URL $plug = $plug->at('another', 'additional', 'endpoint', 'segment')->with('more', 'params'); // how many redirects will we follow? $plug = $plug->withAutoRedirects(2); // HTTP requests often need HTTP headers $plug = $plug->withHeader('X-FcStPauli', 'hells') ->withAddedHeader('X-FcStPauli', 'bells') ->withHeader('X-HSV', 'you\'ll never walk again'); // ...or not $plug = $plug->withoutHeader('X-HSV'); // the Headers object, like XUri and QueryParams, is normally immutable $headers = $plug->getHeaders(); $result = $headers->getHeader('X-FcStPauli'); // ['hells', 'bells'] $result = $headers->getHeaderLine('X-FcStPauli'); // X-HSV: hells, bells // but if you really want to... $mutableHeaders = $headers->toMutableHeaders(); $mutableHeaders->set('X-HSV', 'keiner mag den hsv'); // a Headers object is iterable foreach($mutableHeaders as $header => $values) { foreach($values as $value) { // HTTP headers can have multiple stored values // ...though normally sent via an HTTP client as comma separated on a single HTTP header line echo "{$header}: {$value}"; } } // also we can merge the two sets of Headers (the original and the mutated one) // ...to create a brand new object containing the values of both $mergedHeaders = $headers->toMergedHeaders($mutableHeaders); // we've built out a pretty complex HTTP client now // ...but what if we want a client with a different URL but everything else the same? $alternateApiPlug = $plug->withUri(XUri::newFromString('https://db.example.com/graph')); // we are going to invoke an HTTP request // ...pre and post invocation callbacks can attach special logic and handlers // ...intended to be executed whenever or wherever this HTTP client is used // ...maybe there is some logic we want to always perform at the moment the HTTP request is about to be sent? $plug = $plug->withPreInvokeCallback(function(XUri $uri, IHeaders $headers) { // last chance to change the URL or HTTP headers before the request is made // ...URL and HTTP headers for the single request invocation can be mutated // ...this will not affect the URL or HTTP headers configured in the plug $headers->toMutableHeaders()->addHeader('something', 'contextual'); }); // multiple callbacks can be attached (they are executed in the order they are attached) $plug = $plug->withPreInvokeCallback(function(XUri $uri, IHeaders $headers) { }); // maybe we want to attach some special handlin that always executes when we receive an HTTP response? $plug = $plug->withPostInvokeCallback(function(Result $result) { // perhaps there is special behavior to always trigger based on the HTTP response status code? if($result->is(403)) { } }); // HTTP responses can be parsed from text into traversable data structures by attaching one or more ResultParser objects // ...parsing can be possibly memory intensive, so limits can be put on the allowed size of a response to parse $plug = $plug->withResultParser((new JsonParser())->withMaxContentLength(640000)); // fetching resources is handled via HTTP GET $result = $plug->get(); // deleting resources is handled via HTTP $result = $plug->delete(); // POST or PUT can optionally send data, in a several different content types as needed $result = $plug->post( (new MultiPartFormDataContent([ 'a' => 'b', 'c' => 'd' ])) ->withFileContent(new FileContent('/path/to/file')) ); $result = $plug->put(new FileContent('/path/to/file')); $result = $plug->post(new UrlEncodedFormDataContent([ 'e' => 'f', 'g' => 'h' ])); $result = $plug->post(JsonContent::newFromArray([ 'a' => [ 'multi-dimensional' => [ 'data', 'structure' ] ] ])); $result = $plug->post(XmlContent::newFromArray([ 'another' => [ 'multi-dimensional' => [ 'data', 'structure' ], 'formatted' => 'as xml' ] ])); $result = $plug->put(new TextContent('good old text!')); ``` You are encouraged to explore the library [classes](src) and [tests](tests) to learn more about the capabilities not listed here. Development and Testing ----------------------- [](#development-and-testing) Contributions are always welcome from the community ([there are defects and enhancements to address](https://github.com/modethirteen/HyperPlug/issues)). The library is tested through a combination of [PHPUnit](https://github.com/sebastianbergmann/phpunit), [`MockPlug`](src/Mock) (an interceptor that matches `HyperPlug` invocations and returns mocked responses), and actual [cURL](https://www.php.net/manual/en/book.curl.php)-driven HTTP requests to a locally hosted [httpbin](https://httpbin.org) server. Further code quality is checked using [PHPStan](https://github.com/phpstan/phpstan) (PHP Static Analysis Tool). ``` # fork and clone the HyperPlug repository git clone git@github.com:{username}/HyperPlug.git # install dependencies composer install # start the httpbin container docker-compose up -d # run static analysis checks vendor/bin/phpstan analyse # run tests export HTTPBIN_BASEURI=http://localhost:8080 vendor/bin/phpunit --configuration phpunit.xml.dist ``` ### Health Score 16 — LowBetter than 4% of packages Maintenance0 Infrequent updates — may be unmaintained Popularity20 Limited adoption so far Community10 Small or concentrated contributor base Maturity29 Early-stage or recently created project 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. ### Community Maintainers ![](https://avatars.githubusercontent.com/u/45862?v=4)[James Andrew Vaughn](/maintainers/modethirteen)[@modethirteen](https://github.com/modethirteen) --- Top Contributors [![modethirteen](https://avatars.githubusercontent.com/u/45862?v=4)](https://github.com/modethirteen "modethirteen (49 commits)") ### Embed Badge ![Health badge](/badges/modethirteen-hyperplug/health.svg) ``` [![Health](https://phpackages.com/badges/modethirteen-hyperplug/health.svg)](https://phpackages.com/packages/modethirteen-hyperplug) ``` ### Alternatives [php-http/cache-plugin PSR-6 Cache plugin for HTTPlug 25126.1M82](/packages/php-http-cache-plugin)[illuminate/http The Illuminate Http package. 11937.9M7.0k](/packages/illuminate-http)[rdkafka/rdkafka A PHP extension for Kafka 2.2k24.3k1](/packages/rdkafka-rdkafka)[httpsoft/http-message Strict and fast implementation of PSR-7 and PSR-17 87965.9k114](/packages/httpsoft-http-message)[mezzio/mezzio-router Router subcomponent for Mezzio 265.4M92](/packages/mezzio-mezzio-router)[serpapi/google-search-results-php Get Google, Bing, Baidu, Ebay, Yahoo, Yandex, Home depot, Naver, Apple, Duckduckgo, Youtube search results via SerpApi.com 69127.2k](/packages/serpapi-google-search-results-php) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)