README

This project provides a PHP implementation of the H3 system. The goal of this library is to minimize the complexity and requires for using the H3 library in PHP. All functions are rewritten in PHP so that there are no dependencies.

Use

The test are a great place to look to see each of the supported methods in action. Currently, not all methods of the library are supported, but please feel free to PR any missing methods that you may need.

$h3 = new MichaelLindahl\H3\H3(H3::DYLIB); $h3Index = $h3->latLngToCell(40.689421843699, -74.044431399909, 10); // $h3Index: '8a2a1072b59ffff' 

Structure

This package is structed with H3.php as the main entry point and shared location for any constants used throughout the library. Each section of the API Reference is given it's own Trait and Test file to help maintain organization.

Building the bin directory

In order to build the bin directory on macOS a cross-compiler that is capable of generating Linux objects must be used, e.g.:

brew install FiloSottile/musl-cross/musl-cross 

Contributions

Contributions are welcomed. Please be kind, both in reviewing and contributing. Follow the project goals. And include tests.

Alternatives

• neatlife/php-h3