mirror of
https://github.com/zoe-may/TDoG-Skin.git
synced 2025-01-19 15:07:23 +08:00
105 lines
3.8 KiB
Markdown
Executable File
105 lines
3.8 KiB
Markdown
Executable File
<p align="center">
|
|
<img src="https://static.hoa-project.net/Image/Hoa.svg" alt="Hoa" width="250px" />
|
|
</p>
|
|
|
|
---
|
|
|
|
<p align="center">
|
|
<a href="https://travis-ci.org/hoaproject/visitor"><img src="https://img.shields.io/travis/hoaproject/visitor/master.svg" alt="Build status" /></a>
|
|
<a href="https://coveralls.io/github/hoaproject/visitor?branch=master"><img src="https://img.shields.io/coveralls/hoaproject/visitor/master.svg" alt="Code coverage" /></a>
|
|
<a href="https://packagist.org/packages/hoa/visitor"><img src="https://img.shields.io/packagist/dt/hoa/visitor.svg" alt="Packagist" /></a>
|
|
<a href="https://hoa-project.net/LICENSE"><img src="https://img.shields.io/packagist/l/hoa/visitor.svg" alt="License" /></a>
|
|
</p>
|
|
<p align="center">
|
|
Hoa is a <strong>modular</strong>, <strong>extensible</strong> and
|
|
<strong>structured</strong> set of PHP libraries.<br />
|
|
Moreover, Hoa aims at being a bridge between industrial and research worlds.
|
|
</p>
|
|
|
|
# Hoa\Visitor
|
|
|
|
[](https://webchat.freenode.net/?channels=#hoaproject)
|
|
[](https://gitter.im/hoaproject/central)
|
|
[](https://central.hoa-project.net/Documentation/Library/Visitor)
|
|
[](https://waffle.io/hoaproject/visitor)
|
|
|
|
This library provides interfaces to apply the visitor pattern.
|
|
|
|
[Learn more](https://central.hoa-project.net/Documentation/Library/Visitor).
|
|
|
|
## Installation
|
|
|
|
With [Composer](https://getcomposer.org/), to include this library into
|
|
your dependencies, you need to
|
|
require [`hoa/visitor`](https://packagist.org/packages/hoa/visitor):
|
|
|
|
```sh
|
|
$ composer require hoa/visitor '~2.0'
|
|
```
|
|
|
|
For more installation procedures, please read [the Source
|
|
page](https://hoa-project.net/Source.html).
|
|
|
|
## Testing
|
|
|
|
Before running the test suites, the development dependencies must be installed:
|
|
|
|
```sh
|
|
$ composer install
|
|
```
|
|
|
|
Then, to run all the test suites:
|
|
|
|
```sh
|
|
$ vendor/bin/hoa test:run
|
|
```
|
|
|
|
For more information, please read the [contributor
|
|
guide](https://hoa-project.net/Literature/Contributor/Guide.html).
|
|
|
|
## Quick usage
|
|
|
|
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.
|
|
|
|
## Documentation
|
|
|
|
The
|
|
[hack book of `Hoa\Visitor`](https://central.hoa-project.net/Documentation/Library/Visitor)
|
|
contains detailed information about how to use this library and how it works.
|
|
|
|
To generate the documentation locally, execute the following commands:
|
|
|
|
```sh
|
|
$ 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
|
|
|
|
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
|
|
|
|
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
|
|
|
|
Hoa is under the New BSD License (BSD-3-Clause). Please, see
|
|
[`LICENSE`](https://hoa-project.net/LICENSE) for details.
|