Hoa is a modular, extensible and
structured set of PHP libraries.
Moreover, Hoa aims at being a bridge between industrial and research worlds.
This library provides interfaces to apply the visitor pattern.
With Composer, to include this library into
your dependencies, you need to
require hoa/visitor:
$ composer require hoa/visitor '~2.0'For more installation procedures, please read the Source page.
Before running the test suites, the development dependencies must be installed:
$ composer installThen, to run all the test suites:
$ vendor/bin/hoa test:runFor more information, please read the contributor guide.
We propose to explain the basis of this library. We have two entities: an
element to visit and a visitor, for example a node of a tree and a dumper. The
element to visit will implement the Hoa\Visitor\Element interface and the
visitor will implement the Hoa\Visitor\Visit interface. The first one will ask
to implement the accept method in order to define what data it holds will be
visited. The second one will ask to implement the visit method which will
contain the visitor computations. We will find several examples in Hoa
libraries.
The
hack book of Hoa\Visitor
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 --openMore documentation can be found on the project's website: hoa-project.net.
There are mainly two ways to get help:
- On the
#hoaprojectIRC channel, - On the forum at users.hoa-project.net.
Do you want to contribute? Thanks! A detailed contributor guide explains everything you need to know.
Hoa is under the New BSD License (BSD-3-Clause). Please, see
LICENSE for details.