hoa / json
The Hoa\Json library.
Installs: 3 977
Dependents: 4
Suggesters: 0
Security: 0
Stars: 10
Watchers: 10
Forks: 5
Open Issues: 3
Requires
- hoa/consistency: ~1.0
- hoa/protocol: ~1.0
Requires (Dev)
- hoa/compiler: ~3.0
- hoa/file: ~1.0
- hoa/iterator: ~2.0
- hoa/math: ~1.0
- hoa/regex: ~1.0
- hoa/test: ~2.0
This package is auto-updated.
Last update: 2021-09-20 08:31:16 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\Json
This library provides only the grammar of JSON in the PP format (see the
Hoa\Compiler
library).
Installation
With Composer, to include this library into
your dependencies, you need to
require hoa/json
:
$ composer require hoa/json '~2.0'
For more installation procedures, please read the Source page.
Testing
Before running the json 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 overview, we will see how to use the grammar to parse JSON strings.
Parse JSON strings
All we have to do is to use the Hoa\Compiler
library. For
instance, in CLI:
$ echo '{"foo": 42, "bar": [1, [2, [3, 5], 8], 13]}' | hoa compiler:pp hoa://Library/Json/Grammar.pp 0 -v dump > #object > > #pair > > > token(string:string, foo) > > > token(number, 42) > > #pair > > > token(string:string, bar) > > > #array > > > > token(number, 1) > > > > #array > > > > > token(number, 2) > > > > > #array > > > > > > token(number, 3) > > > > > > token(number, 5) > > > > > token(number, 8) > > > > token(number, 13)
Documentation
The
hack book of Hoa\Json
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.