Files
contao-leaflet-geocode-widget/README.md
David Molineus 268372c12a Fix links (#8)
2022-11-29 11:10:48 +01:00

115 lines
3.6 KiB
Markdown

Leaflet geocode widget
======================
[![Build Status](https://img.shields.io/github/workflow/status/netzmacht/contao-leaflet-geocode-widget/Code%20Quality%20Diagnostics?logo=githubactions&logoColor=%23fff&style=for-the-badge)](https://github.com/netzmacht/contao-leaflet-geocode-widget/actions)
[![Version](http://img.shields.io/packagist/v/netzmacht/contao-leaflet-geocode-widget.svg?style=flat-square)](http://packagist.org/packages/netzmacht/contao-leaflet-geocode-widget)
[![License](http://img.shields.io/packagist/l/netzmacht/contao-leaflet-geocode-widget.svg?style=flat-square)](http://packagist.org/packages/netzmacht/contao-leaflet-geocode-widget)
[![Downloads](http://img.shields.io/packagist/dt/netzmacht/contao-leaflet-geocode-widget.svg?style=flat-square)](http://packagist.org/packages/netzmacht/contao-leaflet-geocode-widget)
This extension provides a widget to pick coordinates from a map. It uses the leaflet framework.
Changlog
--------
See [CHANGELOG](CHANGELOG.md).
Requirements
------------
- Contao ^4.13||^5.0
- PHP ^7.4||^8.0
Install
-------
### 1. Install using composer
```bash
php composer.phar require netzmacht/contao-leaflet-geocode-widget
```
### 2. Update your AppKernel.php
git
If you use the managed edition of Contao you can skip this step.
```php
// Dependency is automatically installed and has to be registered
new Contao\CoreBundle\HttpKernel\Bundle\ContaoModuleBundle('leaflet-libs', $this->getRootDir()),
// Register the bundle
new Netzmacht\Contao\Leaflet\GeocodeWidget\LeafletGeocodeWidgetBundle(),
```
### 3. Update the assets
```bash
bin/console assets:install --symlink
```
### 4. Use the widget
#### Coordinates only
```php
$GLOBALS['TL_DCA']['tl_example']['fields']['coordinates'] = [
'label' => ['Koordinaten', 'Geben Sie die Koordinaten ein'],
'inputType' => 'leaflet_geocode',
'eval' => [
'tl_class' => 'w50',
],
'sql' => 'varchar(255) NOT NULL default \'\''
];
```
#### Coordinates and radius
To pick the radius in meters as well, you have to configure the `eval.radius` option for the related radius field.
The radius field should be a simle text input. The `default`, `minval` and `maxval` flags are passed to the geocode
widget so that only radius in that boundary can be chosen.
```php
$GLOBALS['TL_DCA']['tl_page']['fields']['coordinates'] = [
'label' => ['Koordinaten', 'Geben Sie die Koordinaten ein'],
'inputType' => 'leaflet_geocode',
'eval' => [
'tl_class' => 'w50',
'radius' => 'radius'
],
'sql' => 'varchar(255) NOT NULL default \'\''
];
$GLOBALS['TL_DCA']['tl_page']['fields']['radius'] = [
'label' => ['Radius', 'Angabe des Radius in Metern'],
'inputType' => 'leaflet_radius', // Optional, you can use a text widget as well
'eval' => [
'default' => 500,
'minval' => 100,
'maxval' => 5000,
'steps' => 100, // Round value to the closest 100m.
'tl_class' => 'w50',
],
'sql' => 'varchar(255) NOT NULL default \'\''
];
```
If you want to add an wizard icon to the radius field as well, you only have to reference the coordinates field.
```php
$GLOBALS['TL_DCA']['tl_page']['fields']['radius'] = [
'label' => ['Radius', 'Angabe des Radius in Metern'],
'inputType' => 'leaflet_radius',
'eval' => [
'rgxp' => 'natural',
'default' => 500,
'minval' => 100,
'maxval' => 5000,
'tl_class' => 'w50 wizard',
'coordinates' => 'coordinates'
],
'sql' => 'varchar(255) NOT NULL default \'\''
];
```