|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115 |
- LeafLet Extension for Yii2
- ==========================
-
- [![Latest Version](https://img.shields.io/github/tag/2amigos/yii2-leaflet-extension.svg?style=flat-square&label=release)](https://github.com/2amigos/yii2-leaflet-extension/tags)
- [![Software License](https://img.shields.io/badge/license-BSD-brightgreen.svg?style=flat-square)](LICENSE.md)
- [![Build Status](https://img.shields.io/travis/2amigos/yii2-leaflet-extension/master.svg?style=flat-square)](https://travis-ci.org/2amigos/yii2-leaflet-extension)
- [![Coverage Status](https://img.shields.io/scrutinizer/coverage/g/2amigos/yii2-leaflet-extension.svg?style=flat-square)](https://scrutinizer-ci.com/g/2amigos/yii2-leaflet-extension/code-structure)
- [![Total Downloads](https://img.shields.io/packagist/dt/2amigos/yii2-leaflet-extension.svg?style=flat-square)](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 <a href="http://www.mapquest.com/" target="_blank">MapQuest</a> ' .
- '<img src="http://developer.mapquest.com/content/osm/mq_logo.png">, ' .
- 'Map data © <a href="http://openstreetmap.org">OpenStreetMap</a> contributors, <a href="http://creativecommons.org/licenses/by-sa/2.0/">CC-BY-SA</a>',
- '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.
-
- > [![2amigOS!](http://www.gravatar.com/avatar/55363394d72945ff7ed312556ec041e0.png)](http://www.2amigos.us)
- <i>Web development has never been so fun!</i>
- [www.2amigos.us](http://www.2amigos.us)
|