hoa / registry
The Hoa\Registry library.
Installs: 19 619
Dependents: 1
Suggesters: 0
Security: 0
Stars: 11
Watchers: 11
Forks: 9
Open Issues: 4
Requires
- hoa/consistency: ~1.0
- hoa/exception: ~1.0
- hoa/protocol: ~1.0
Requires (Dev)
- hoa/test: ~2.0
This package is auto-updated.
Last update: 2021-09-20 08:31:47 UTC
README
Hoa is a modular, extensible and
structured set of PHP libraries.
Moreover, Hoa aims at being a bridge between industrial and research worlds.
Hoa\Registry
This library offers a static registry that stores key/value combinations. Any kind of PHP variable can be stored: an array, an object, a resource…
Installation
With Composer, to include this library into
your dependencies, you need to
require hoa/registry
:
$ composer require hoa/registry '~3.0'
For more installation procedures, please read the Source page.
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.
Quick usage
As a quick example, we set an entry and retrieve it. The retrieval can be done
with a static method on the Hoa\Registry\Registry
class and also using the
hoa://
protocol.
Hoa\Register\Registry::set('foo', 'bar'); var_dump( Hoa\Registry\Registry::get('foo'), resolve('hoa://Library/Registry#foo') ); /** * Will output: * string(3) "bar" * string(3) "bar" */
Documentation
The
hack book of Hoa\Registry
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.
Getting help
There are mainly two ways to get help:
- On the
#hoaproject
IRC channel, - On the forum at users.hoa-project.net.
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.