LeafLet Extension for Yii2
==========================
[](https://github.com/2amigos/yii2-leaflet-extension/tags)
[](LICENSE.md)
[](https://travis-ci.org/2amigos/yii2-leaflet-extension)
[](https://scrutinizer-ci.com/g/2amigos/yii2-leaflet-extension/code-structure)
[](https://packagist.org/packages/2amigos/yii2-leaflet-extension)
Extension library to display interactive maps with [LeafletJs](http://leafletjs.com/)
Installation
------------
The preferred way to install this extension is through
[composer](http://getcomposer.org/download/). This requires the
[`composer-asset-plugin`](https://github.com/francoispluchino/composer-asset-plugin),
which is also a dependency for yii2 – so if you have yii2 installed, you are
most likely already set.
Either run
```
composer require 2amigos/yii2-leaflet-extension:~1.0
```
or add
```json
"2amigos/yii2-leaflet-extension" : "~1.0"
```
to the require section of your application's `composer.json` file.
Usage
-----
One of the things to take into account when working with [LeafletJs](http://leafletjs.com/) is that we need a Tile
Provider. Is very important, if we fail to provide a Tile Provider Url, the map will display plain, without any maps at
all.
The following example, is making use of [MapQuest](http://developer.mapquest.com/):
```
// first lets setup the center of our map
$center = new dosamigos\leaflet\types\LatLng(['lat' => 51.508, 'lng' => -0.11]);
// now lets create a marker that we are going to place on our map
$marker = new \dosamigos\leaflet\layers\Marker(['latLng' => $center, 'popupContent' => 'Hi!']);
// The Tile Layer (very important)
$tileLayer = new \dosamigos\leaflet\layers\TileLayer([
'urlTemplate' => 'http://otile{s}.mqcdn.com/tiles/1.0.0/map/{z}/{x}/{y}.jpeg',
'clientOptions' => [
'attribution' => 'Tiles Courtesy of MapQuest ' .
'
, ' .
'Map data © OpenStreetMap contributors, CC-BY-SA',
'subdomains' => '1234'
]
]);
// now our component and we are going to configure it
$leaflet = new \dosamigos\leaflet\LeafLet([
'center' => $center, // set the center
]);
// Different layers can be added to our map using the `addLayer` function.
$leaflet->addLayer($marker) // add the marker
->addLayer($tileLayer); // add the tile layer
// finally render the widget
echo \dosamigos\leaflet\widgets\Map::widget(['leafLet' => $leaflet]);
// we could also do
// echo $leaflet->widget();
```
Testing
-------
To test the extension, is better to clone this repository on your computer. After, go to the extensions folder and do
the following (assuming you have `composer` installed on your computer):
```bash
$ composer install --no-interaction --prefer-source --dev
```
Once all required libraries are installed then do:
```bash
$ vendor/bin/phpunit
```
Further Information
-------------------
For further information regarding the multiple settings of LeafLetJS library please visit
[its API reference](http://leafletjs.com/reference.html)
Contributing
------------
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
Credits
-------
- [Antonio Ramirez](https://github.com/tonydspaniard)
- [All Contributors](../../contributors)
License
-------
The BSD License (BSD). Please see [License File](LICENSE.md) for more information.
> [](http://www.2amigos.us)
Web development has never been so fun!
[www.2amigos.us](http://www.2amigos.us)