Skip to content

Commit 27c10c6

Browse files
garrettrayjgarrettrayj
committed
Update README and API docs.
1 parent c3938bd commit 27c10c6

21 files changed

+128
-146
lines changed

‎README.md‎

Lines changed: 36 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,17 @@ PHP7 Mapnik
66
Introduction
77
------------
88

9-
PHP7 Mapnik brings geospatial rendering to PHP via the powerful [Mapnik](http://mapnik.org/) XML API.
10-
It is ideal for building dynamic tile servers or livening up websites with custom static maps.
9+
PHP7 Mapnik is an extension that enables geospatial rendering with [Mapnik](http://mapnik.org/).
10+
Create tile generation scripts, dynamic tile services, or static maps with Mapnik XML and PHP.
11+
12+
* [API Documentation](http://garrettrayj.github.io/php7-mapnik/api/)
13+
* [Mapnik on GitHub](https://github.com/mapnik/mapnik)
14+
* [Mapnik XML Config Reference](https://github.com/mapnik/mapnik/wiki/XMLConfigReference)
1115

1216
[![Build Status](https://travis-ci.org/garrettrayj/php7-mapnik.svg?branch=master)](https://travis-ci.org/garrettrayj/php7-mapnik)
1317

18+
19+
1420
Requirements
1521
------------
1622

@@ -25,7 +31,7 @@ Requirements
2531
Installation
2632
------------
2733

28-
# git clone ... && cd php7-mapnik
34+
git clone https://github.com/garrettrayj/php7-mapnik.git && cd php7-mapnik
2935
phpize
3036
./configure --with-mapnik
3137
make test
@@ -37,40 +43,44 @@ Note: Your PHP configuration directory may be different depending on OS and PHP
3743
Tile Server Example
3844
-------------------
3945

46+
Run the example...
47+
4048
./example/run.sh
4149

42-
Point your web browser to [http://localhost:8000/](http://localhost:8000/)
50+
...then visit [http://localhost:8000/](http://localhost:8000/)
4351

4452
Usage
4553
-----
4654

47-
<?php
55+
See the [API Documentation](http://garrettrayj.github.io/php7-mapnik/api/) for the complete breakdown of available functionality.
56+
57+
```php
58+
<?php
4859

49-
// Register datasource plugins
50-
$pluginConfigOutput = [];
51-
exec('mapnik-config --input-plugins', $pluginConfigOutput);
52-
\Mapnik\DatasourceCache::registerDatasources($pluginConfigOutput[0]);
60+
// Register datasource plugins
61+
// Use `mapnik-config --input-plugins` to get input plugin directory
62+
\Mapnik\DatasourceCache::registerDatasources('/usr/local/lib/mapnik/input');
5363

54-
// Create map
55-
$map = new \Mapnik\Map(640, 480);
64+
// Create map
65+
$map = new \Mapnik\Map(640, 480);
5666

57-
// Register fonts
58-
$fontConfigOutput = [];
59-
exec('mapnik-config --fonts', $fontConfigOutput);
60-
$map->registerFonts($fontConfigOutput[0]);
67+
// Register fonts
68+
// Use `mapnik-config --fonts` to get Mapnik fonts directory
69+
$map->registerFonts('/usr/local/lib/mapnik/fonts');
6170

62-
// Load Mapnik XML
63-
$map->loadXmlFile('my_awesome_map.xml', false, $basePath);
71+
// Load Mapnik XML
72+
$map->loadXmlFile('my_awesome_map.xml', false, $basePath);
6473

65-
// Situate the map within the viewport
66-
$map->zoomAll();
74+
// Situate map content within canvas
75+
$map->zoomAll();
6776

68-
// Create image
69-
$image = new \Mapnik\Image(640, 480);
77+
// Create image
78+
$image = new \Mapnik\Image(640, 480);
7079

71-
// Render
72-
$renderer = new \Mapnik\AggRenderer($map, $image);
73-
$renderer->apply();
80+
// Render
81+
$renderer = new \Mapnik\AggRenderer($map, $image);
82+
$renderer->apply();
7483

75-
// Save PNG image
76-
$image->saveToFile('my_awesome_map.png');
84+
// Save PNG image file
85+
$image->saveToFile('my_awesome_map.png');
86+
```

‎docs/api/Mapnik/AggRenderer.html‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,14 +81,12 @@ <h1>
8181
</div>
8282

8383
<p> class
84-
<strong>AggRenderer</strong> (<a href="https://github.com/garrettrayj/php7-mapnik/blob/master/docs/prototypes/Mapnik/AggRenderer.php">View source</a>)
84+
<strong>AggRenderer</strong>
8585
</p>
8686

8787

8888

8989

90-
<div class="description">
91-
<p>Class AggRenderer</p> </div>
9290

9391

9492

@@ -124,7 +122,7 @@ <h2>Details</h2>
124122
<div id="method-details">
125123
<div class="method-item">
126124
<h3 id="method___construct">
127-
<div class="location">at <a href="https://github.com/garrettrayj/php7-mapnik/blob/master/docs/prototypes/Mapnik/AggRenderer.php#L20">line 20</a></div>
125+
<div class="location">at line 18</div>
128126
<code>
129127
<strong>__construct</strong>(<a href="../Mapnik/Map.html"><abbr title="Mapnik\Map">Map</abbr></a> $map, <a href="../Mapnik/Image.html"><abbr title="Mapnik\Image">Image</abbr></a> $image)
130128
</code>
@@ -160,7 +158,7 @@ <h4>Parameters</h4>
160158
</div>
161159
<div class="method-item">
162160
<h3 id="method_apply">
163-
<div class="location">at <a href="https://github.com/garrettrayj/php7-mapnik/blob/master/docs/prototypes/Mapnik/AggRenderer.php#L25">line 25</a></div>
161+
<div class="location">at line 23</div>
164162
<code>
165163
<strong>apply</strong>()
166164
</code>

‎docs/api/Mapnik/Box2D.html‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,6 @@ <h1>
8787

8888

8989

90-
<div class="description">
91-
<p>Class Box2D</p> </div>
9290

9391

9492

@@ -154,7 +152,7 @@ <h2>Details</h2>
154152
<div id="method-details">
155153
<div class="method-item">
156154
<h3 id="method___construct">
157-
<div class="location">at line 21</div>
155+
<div class="location">at line 19</div>
158156
<code>
159157
<strong>__construct</strong>(float $minX, float $minY, float $maxX, float $maxY)
160158
</code>
@@ -200,7 +198,7 @@ <h4>Parameters</h4>
200198
</div>
201199
<div class="method-item">
202200
<h3 id="method_minX">
203-
<div class="location">at line 28</div>
201+
<div class="location">at line 26</div>
204202
<code> float
205203
<strong>minX</strong>()
206204
</code>
@@ -230,7 +228,7 @@ <h4>Return Value</h4>
230228
</div>
231229
<div class="method-item">
232230
<h3 id="method_minY">
233-
<div class="location">at line 35</div>
231+
<div class="location">at line 33</div>
234232
<code> float
235233
<strong>minY</strong>()
236234
</code>
@@ -260,7 +258,7 @@ <h4>Return Value</h4>
260258
</div>
261259
<div class="method-item">
262260
<h3 id="method_maxX">
263-
<div class="location">at line 42</div>
261+
<div class="location">at line 40</div>
264262
<code> float
265263
<strong>maxX</strong>()
266264
</code>
@@ -290,7 +288,7 @@ <h4>Return Value</h4>
290288
</div>
291289
<div class="method-item">
292290
<h3 id="method_maxY">
293-
<div class="location">at line 49</div>
291+
<div class="location">at line 47</div>
294292
<code> float
295293
<strong>maxY</strong>()
296294
</code>

‎docs/api/Mapnik/DatasourceCache.html‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,14 +81,12 @@ <h1>
8181
</div>
8282

8383
<p> class
84-
<strong>DatasourceCache</strong> (<a href="https://github.com/garrettrayj/php7-mapnik/blob/master/docs/prototypes/Mapnik/DatasourceCache.php">View source</a>)
84+
<strong>DatasourceCache</strong>
8585
</p>
8686

8787

8888

8989

90-
<div class="description">
91-
<p>Class DatasourceCache</p> </div>
9290

9391

9492

@@ -124,7 +122,7 @@ <h2>Details</h2>
124122
<div id="method-details">
125123
<div class="method-item">
126124
<h3 id="method_registerDatasources">
127-
<div class="location">at <a href="https://github.com/garrettrayj/php7-mapnik/blob/master/docs/prototypes/Mapnik/DatasourceCache.php#L18">line 18</a></div>
125+
<div class="location">at line 16</div>
128126
<code> static
129127
<strong>registerDatasources</strong>(string $path)
130128
</code>
@@ -155,7 +153,7 @@ <h4>Parameters</h4>
155153
</div>
156154
<div class="method-item">
157155
<h3 id="method_getPluginNames">
158-
<div class="location">at <a href="https://github.com/garrettrayj/php7-mapnik/blob/master/docs/prototypes/Mapnik/DatasourceCache.php#L25">line 25</a></div>
156+
<div class="location">at line 23</div>
159157
<code> static array
160158
<strong>getPluginNames</strong>()
161159
</code>

‎docs/api/Mapnik/Exception.html‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,14 +81,12 @@ <h1>
8181
</div>
8282

8383
<p> class
84-
<strong>Exception</strong> extends <a target="_blank" href="http://php.net/Exception">Exception</a> (<a href="https://github.com/garrettrayj/php7-mapnik/blob/master/docs/prototypes/Mapnik/Exception.php">View source</a>)
84+
<strong>Exception</strong> extends <a target="_blank" href="http://php.net/Exception">Exception</a>
8585
</p>
8686

8787

8888

8989

90-
<div class="description">
91-
<p>Class Exception</p> </div>
9290

9391

9492

‎docs/api/Mapnik/Image.html‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -81,14 +81,12 @@ <h1>
8181
</div>
8282

8383
<p> class
84-
<strong>Image</strong> (<a href="https://github.com/garrettrayj/php7-mapnik/blob/master/docs/prototypes/Mapnik/Image.php">View source</a>)
84+
<strong>Image</strong>
8585
</p>
8686

8787

8888

8989

90-
<div class="description">
91-
<p>Class Image</p> </div>
9290

9391

9492

@@ -134,7 +132,7 @@ <h2>Details</h2>
134132
<div id="method-details">
135133
<div class="method-item">
136134
<h3 id="method___construct">
137-
<div class="location">at <a href="https://github.com/garrettrayj/php7-mapnik/blob/master/docs/prototypes/Mapnik/Image.php#L18">line 18</a></div>
135+
<div class="location">at line 16</div>
138136
<code>
139137
<strong>__construct</strong>(int $width, int $height)
140138
</code>
@@ -170,7 +168,7 @@ <h4>Parameters</h4>
170168
</div>
171169
<div class="method-item">
172170
<h3 id="method_saveToFile">
173-
<div class="location">at <a href="https://github.com/garrettrayj/php7-mapnik/blob/master/docs/prototypes/Mapnik/Image.php#L27">line 27</a></div>
171+
<div class="location">at line 25</div>
174172
<code>
175173
<strong>saveToFile</strong>(string $file, string $format = &#039;png&#039;)
176174
</code>
@@ -215,7 +213,7 @@ <h4>See also</h4>
215213
</div>
216214
<div class="method-item">
217215
<h3 id="method_saveToString">
218-
<div class="location">at <a href="https://github.com/garrettrayj/php7-mapnik/blob/master/docs/prototypes/Mapnik/Image.php#L36">line 36</a></div>
216+
<div class="location">at line 34</div>
219217
<code> string
220218
<strong>saveToString</strong>(string $format = &#039;png&#039;)
221219
</code>

0 commit comments

Comments
 (0)