PHPackages                             hiqdev/hoa-protocol - 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. [Utility & Helpers](/categories/utility)
4. /
5. hiqdev/hoa-protocol

ActiveLibrary[Utility & Helpers](/categories/utility)

hiqdev/hoa-protocol
===================

The Hiqdev Hoa\\Protocol library.

1.0.2(3y ago)18.9k↓20%21BSD-3-ClausePHPPHP >=7.4

Since Jul 6Pushed 3y agoCompare

[ Source](https://github.com/hiqdev/hoa-protocol)[ Packagist](https://packagist.org/packages/hiqdev/hoa-protocol)[ RSS](/packages/hiqdev-hoa-protocol/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (4)Versions (4)Used By (1)

Reasons to fork
---------------

[](#reasons-to-fork)

The Hoa project was archived, and no upgrades or patches are neither provided nor accepted by merge requests.

HOA Packages include some code that is Deprecated for PHP 8.0 and PHP 8.1, but we needed these packages to run on modern PHP versions.

What's changed in from?
-----------------------

[](#whats-changed-in-from)

The changes mainly affected the return data type hinting in methods declaration, access to uninitialized properties.

How to use
----------

[](#how-to-use)

We've currently forked the following packages, primarily to make hoa/ruler work with PHP 8.1:

Original packageForked packagehoa/rulerhiqdev/hoa-rulerhoa/compilerhiqdev/hoa-compilerhoa/protocolhiqdev/hoa-protocolhoa/iteratorhiqdev/hoa-iteratorYou can simply replace requirements in composer.json from hoa packages to the corresponding forked packages: there is no need to change something in the codebase. If you use someone's package, that requires hoa – simply add forks to your project root composer.json: we have marked forks as a replacement, so composer will install them instead of the original packages.

Versions
--------

[](#versions)

We've forked from the latest hoa package versions and bump own versions starting from 1.0.

Testing
-------

[](#testing)

Before running the test suites, the development dependencies must be installed:

```
$ composer install
```

Then, to run all the test suites:

```
$ vendor/bin/hoa test:run
```

For more information, please read the [contributor guide](https://hoa-project.net/Literature/Contributor/Guide.html).

Quick usage
-----------

[](#quick-usage)

We propose a quick overview of how to list the current tree of the protocol, how to resolve a `hoa://` path and finally how to add a new node in this tree.

### Explore resources

[](#explore-resources)

First of all, to get the instance of the `hoa://` protocol, you should use the static `getInstance` method on the `Hoa\Protocol\Protocol` class which represents the root of the protocol tree:

```
echo Hoa\Protocol\Protocol::getInstance();

/**
 * Might output:
 *   Application
 *     Public
 *   Data
 *     Etc
 *       Configuration
 *       Locale
 *     Lost+found
 *     Temporary
 *     Variable
 *       Cache
 *       Database
 *       Log
 *       Private
 *       Run
 *       Test
 *   Library
 */
```

We see that there is 3 “sub-roots”:

1. `Application`, representing resources of the application, like public files (in the `Public` node), models, resources… everything related to the application,
2. `Data`, representing data required by the application, like configuration files, locales, databases, tests etc.
3. `Library`, representing all Hoa's libraries.

Thus, `hoa://Library/Protocol/README.md` represents the abstract path to this real file. No matter where you are on the disk, this path will always be valid and pointing to this file. This becomes useful in an application where you would like to access to a configuration file like this `hoa://Data/Etc/Configuration/Foo.php`: Maybe the `Data` directory does not exist, maybe the `Etc` or `Configuration` directories do not exist neither, but each node of the `hoa://` tree resolves to a valid directory which contains your `Foo.php` configuration file. This is an **abstract path for a resource**.

### Resolving a path

[](#resolving-a-path)

We can either resolve a path by using the global `resolve` function or the `Hoa\Protocol\Protocol::resolve` method:

```
var_dump(
    resolve('hoa://Library/Protocol/README.md')
);

/**
 * Might output:
 *     string(37) "/usr/local/lib/Hoa/Protocol/README.md"
 */
```

### Register new nodes in the tree

[](#register-new-nodes-in-the-tree)

The `hoa://` protocol is a tree. Thus, to add a new “component”/“directory” in this tree, we must create a node and register it as a child of an existing node. Thus, in the following example we will create a `Usb` node, pointing to the `/Volumes` directory, and we will add it as a new sub-root, so an immediate child of the root:

```
$protocol   = Hoa\Protocol\Protocol::getInstance();
$protocol[] = new Hoa\Protocol\Node('Usb', '/Volumes/');
```

Here we are. Now, resolving `hoa://Usb/StickA` might point to `/Volumes/StickA`(if exists):

```
var_dump(
    resolve('hoa://Usb/StickA')
);

/**
 * Might output:
 *     string(15) "/Volumes/StickA"
 */
```

Documentation
-------------

[](#documentation)

The [hack book of `Hoa\Protocol`](https://central.hoa-project.net/Documentation/Library/Protocol)contains detailed information about how to use this library and how it works.

To generate the documentation locally, execute the following commands:

```
$ composer require --dev hoa/devtools
$ vendor/bin/hoa devtools:documentation --open
```

More documentation can be found on the project's website: [hoa-project.net](https://hoa-project.net/).

Getting help
------------

[](#getting-help)

There are mainly two ways to get help:

- On the [`#hoaproject`](https://webchat.freenode.net/?channels=#hoaproject)IRC channel,
- On the forum at [users.hoa-project.net](https://users.hoa-project.net).

Contribution
------------

[](#contribution)

Do you want to contribute? Thanks! A detailed [contributor guide](https://hoa-project.net/Literature/Contributor/Guide.html) explains everything you need to know.

License
-------

[](#license)

Hoa is under the New BSD License (BSD-3-Clause). Please, see [`LICENSE`](https://hoa-project.net/LICENSE) for details.

###  Health Score

30

—

LowBetter than 64% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity27

Limited adoption so far

Community16

Small or concentrated contributor base

Maturity49

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 79% 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 ~11 days

Total

3

Last Release

1389d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/790fd24da129907d373559f60c6994f664f06e3f518502c03580cc9f3594615e?d=identicon)[hiqdev](/maintainers/hiqdev)

---

Top Contributors

[![Hywan](https://avatars.githubusercontent.com/u/946104?v=4)](https://github.com/Hywan "Hywan (49 commits)")[![tafid](https://avatars.githubusercontent.com/u/3338188?v=4)](https://github.com/tafid "tafid (4 commits)")[![ValeriyShnurovoy](https://avatars.githubusercontent.com/u/16237008?v=4)](https://github.com/ValeriyShnurovoy "ValeriyShnurovoy (4 commits)")[![Grummfy](https://avatars.githubusercontent.com/u/668804?v=4)](https://github.com/Grummfy "Grummfy (2 commits)")[![vonglasow](https://avatars.githubusercontent.com/u/1275202?v=4)](https://github.com/vonglasow "vonglasow (2 commits)")[![Metalaka](https://avatars.githubusercontent.com/u/5406767?v=4)](https://github.com/Metalaka "Metalaka (1 commits)")

---

Tags

streamlibraryprotocolwrapperresource

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/hiqdev-hoa-protocol/health.svg)

```
[![Health](https://phpackages.com/badges/hiqdev-hoa-protocol/health.svg)](https://phpackages.com/packages/hiqdev-hoa-protocol)
```

###  Alternatives

[trafficcophp/bytebuffer

Node.js inspired byte stream buffer for PHP.

33437.2k17](/packages/trafficcophp-bytebuffer)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)