kpebedko22/filament-yandex-map
This package provides a set of tools for using Yandex Map within the Laravel Filament.
You can install the package via composer:
composer require kpebedko22/filament-yandex-map
Modify services.php config file. This is the contents of the config file:
return [
// ...
'yandex_map' => [
'api_key' => env('YANDEX_MAP_API_KEY', ''),
'suggest_api_key' => env('YANDEX_MAP_SUGGEST_API_KEY', ''),
'lang' => 'ru_RU',
'center' => [53.35, 83.75],
'zoom' => 12,
],
];
Optionally, you can publish the translations using:
php artisan vendor:publish --tag="filament-yandex-map-translations"
->schema([
YandexMap::make('point')
// Set mode of geo-object. Always required!
->mode(YandexMapMode::Placemark)
// By default, values are taken from config
// You are free to override them using plain values or closure
->apiKey('your_yandex_api_key')
->suggestApiKey('your_yandex_suggest_api_key')
->center([53.35, 83.75])
->zoom(12)
->lang('ru_RU')
// By default: 600px
->height('600px')
// Setup control buttons
->deleteBtnParameters(
new ButtonData(__('filament-yandex-map::control-buttons.delete')),
new ButtonOptions(
float: ButtonFloat::Right,
selectOnClick: false
),
)
->drawBtnParameters()
->editBtnParameters()
// Setup geo-object
->geoObjectOptions(new GeoObjectOptions())
->geoObjectProperties(new GeoObjectProperties())
// It's required to set up `formatStateUsing`, `dehydrateStateUsing` methods
// to properly take data from record. The package provides some implementations
// for common cases. Find more information further below.
->usingArray('lat', 'lng')
->usingMagellan()
])
->schema([
YandexMapEntry::make('point')
// Set mode of geo-object. Always required!
->mode(YandexMapMode::Placemark)
// By default, values are taken from config
// You are free to override them using plain values or closure
->apiKey('your_yandex_api_key')
->suggestApiKey('your_yandex_suggest_api_key')
->center([53.35, 83.75])
->zoom(12)
->lang('ru_RU')
// By default: 600px
->height('600px')
// Setup geo-object
->geoObjectOptions(new GeoObjectOptions())
->geoObjectProperties(new GeoObjectProperties())
// It's required to set up `getStateUsing` method
// to properly take data from record. The package provides some implementations
// for common cases. Find more information further below.
->usingArray('lat', 'lng')
->usingMagellan()
])
The package provides work with the following types of geometries (geo-objects):
Since there are different ways to store geo-object data in database table, the package cannot cover all options. But it provides two out-of-the-box usage options:
The package uses array of two coordinates [lat, lng] for storing point coordinates.
E.g.: [53.35, 83.75], where 53.35 is latitude and 83.75 is longitude.
If you're store coordinates of point as json-object, e.g.: {"lat": 53.35, "lng": 83.75}, then you
should use ->usingArray('lat', 'lng') method.
For ease of working with postgis columns it's recommended to use Laravel Magellan package.
The package supports work with the following geometries:
| Class | Migration |
|---|---|
Clickbar\Magellan\Data\Geometries\Point |
$table->magellanPoint('point') |
Clickbar\Magellan\Data\Geometries\LineString |
$table->magellanLineString('line') |
Clickbar\Magellan\Data\Geometries\Polygon |
$table->magellanPolygon('polygon') |
If you are storing latitude and longitude of the point in the different columns
of your database table, then you need to write your own implementation
of formatStateUsing and mutate data before saving.
// On the form
use Kpebedko22\FilamentYandexMap\Forms\Components\YandexMap;
use Kpebedko22\FilamentYandexMap\ValueObjects\Point;
use Kpebedko22\FilamentYandexMap\Enums\YandexMapMode;
YandexMap::make('point')
->mode(YandexMapMode::Placemark)
->formatStateUsing(static function (?Model $record) {
return $record
? (new Point($record->lat, $record->lng))->toArray()
: null;
}),
// CreatePage
protected function mutateFormDataBeforeCreate(array $data): array
{
$data['lat'] = $data['point']['lat'];
$data['lng'] = $data['point']['lng'];
unset($data['point']);
return parent::mutateFormDataBeforeCreate($data);
}
// EditPage
protected function mutateFormDataBeforeSave(array $data): array
{
$data['lat'] = $data['point']['lat'];
$data['lng'] = $data['point']['lng'];
unset($data['point']);
return parent::mutateFormDataBeforeSave($data);
}
The list of available locales can be found in YandexMapLang enum.
List of available control buttons:
Since the form may require using several map components, there is a nuance with
the automatic inclusion of editor.startDrawing(), editor.startEditing().
The last loaded map component will dominate. Therefore, in order to
edit/draw on the map, control buttons are added that include these functions.
There is also a button to delete a geo-object.
Default state of control buttons:
YandexMap::make('point')
->mode(YandexMapMode::Placemark)
->deleteBtnParameters(
new ButtonData(__('filament-yandex-map::control-buttons.delete')),
new ButtonOptions(
float: ButtonFloat::Right,
selectOnClick: false
),
);
->drawBtnParameters(
new ButtonData(__('filament-yandex-map::control-buttons.draw')),
new ButtonOptions(float: ButtonFloat::Right),
);
->editBtnParameters(
new ButtonData(__('filament-yandex-map::control-buttons.edit')),
new ButtonOptions(float: ButtonFloat::Right),
);
You are free to change the visual state of this control buttons.
You can modify geo-object properties and options.
No tests yet.
composer test
Detailed information about sandbox you can find in Sandbox README file.
Setup ./sandbox/.env file.
Create a symlink to the .env file in the project root:
ln -sf ./sandbox/.env ./.env
Build and start Docker containers:
make build
make up
Run Artisan commands inside the fpm container.
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.
How can I help you explore Laravel packages today?