Skip to content

Latest commit

 

History

History
86 lines (74 loc) · 2.04 KB

README.md

File metadata and controls

86 lines (74 loc) · 2.04 KB
Raw

Polyline (PECL)

Embedded Polyline Encoder Module

Installation

#!/bin/sh
# Get source
git clone http://git.emcconville.com/php_polyline.git
# Change directory
cd php_polyline
# Included local configuration
phpize
# Auto-configure
./configure
# Compile
make
# Verify
make test
# Copy shared object to extension directory.
# Use `php-config --extension-dir`, or `sudo make install`
sudo cp modules/polyline.so /path/to/ext
# Enable extension in php.ini by adding the following line in `php.ini'
# extension=polyline.so

Functions

polyline_encode

string polyline_encode ( array $points )

Returns an encoded string, or FALSE on failure.

polyline_decode

array polyline_decode ( string $encoded )

Returns array of points decoded from a given string, or FALSE on failure.

polyline_validate_encoded_string

bool polyline_validate_encoded_string( string $encded )

Evaluates if a given string is a valid encoded string.

Usage

Encode polyline

$points=array(
  array(41.79999,-87.58695),
  array(41.79959,-87.58692),
  array(41.79959,-87.58741),
  array(41.79958,-87.58900),
  array(41.79956,-87.59037),
  array(41.79950,-87.59037),
  array(41.79949,-87.59206)
);
$encoded = polyline_encode($points);
//=> "}`c~FlyquOnAE?`B@|HBpGJ?@pI"

Decode polyline

$points = polyline_decode("}`c~FlyquOnAE?`B@|HBpGJ?@pI");
//=> array(array(41.79999,-87.58695), /*...*/, array(41.79949,-87.59206))

Hacking (ini settings)

Size of point "tuple"

The tuple of each point can be adjusted with the following INI setting

; integer (default 2)
polyline.tuple = 2

Precision level can also be adjusted

; integer (default 5)
polyline.precision = 5

!!!Note!!! : Most third parties expect a "point" to be defined as two doubles, and encoded with a precision level of 1e5. Changing tuple & precision will not guaranty that generated strings can be decoded.