Download the PHP package hiqdev/hoa-protocol without Composer

On this page you can find all versions of the php package hiqdev/hoa-protocol. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of hiqdev/hoa-protocol

Informations about the package hoa-protocol

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?

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

How to use

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

Original packageForked package
hoa/rulerhiqdev/hoa-ruler
hoa/compilerhiqdev/hoa-compiler
hoa/protocolhiqdev/hoa-protocol
hoa/iteratorhiqdev/hoa-iterator

You 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

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

Testing

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

Then, to run all the test suites:

For more information, please read the contributor guide.

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

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:

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

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

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:

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

Documentation

The hack book of Hoa\Protocol contains detailed information about how to use this library and how it works.

To generate the documentation locally, execute the following commands:

More documentation can be found on the project's website: hoa-project.net.

Getting help

There are mainly two ways to get help:

Contribution

Do you want to contribute? Thanks! A detailed contributor guide explains everything you need to know.

License

Hoa is under the New BSD License (BSD-3-Clause). Please, see LICENSE for details.

All versions of hoa-protocol with dependencies

PHP Build Version
Package Version
Requires php Version >=7.4
hoa/consistency Version ~1.0
hoa/exception Version ~1.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package hiqdev/hoa-protocol contains the following files

Loading the files please wait ....