salaun / geonames
Geonames importer and models for Eloquent ORM. This repo is a fork from Yurtesen/Geonames.
Requires
- php: ^8.0
- illuminate/contracts: ^8.0
- spatie/laravel-package-tools: ^1.4
Requires (Dev)
- nunomaduro/collision: ^5.3
- orchestra/testbench: ^6.15
- pestphp/pest: ^1.18
- pestphp/pest-plugin-laravel: ^1.1
- pestphp/pest-plugin-mock: ^1.0
- pestphp/pest-plugin-parallel: ^0.3.1
- pestphp/pest-plugin-watch: 1.x-dev
- spatie/pest-plugin-test-time: ^1.0
- vimeo/psalm: ^4.8
README
This package provides a way to import/update a local copy of GeoNames databases. The data is retrieved from GeoNames text file export on a public server. You are welcome to read GeoNames README for more informations on this service.
Installation
Note: If you are using Lumen. You have to first install irazasyed/larasupport !
You can install the package via composer:
composer require salaun/geonames
You can publish and run the migrations with:
php artisan vendor:publish --provider="Salaun\Geonames\GeonamesServiceProvider" --tag="geonames-migrations"
php artisan migrate
You can publish the config file with:
php artisan vendor:publish --provider="Salaun\Geonames\GeonamesServiceProvider" --tag="geonames-config"
This is the contents of the published config file:
return [
];
Usage
Please see the wiki for further information.
Provided Eloquent Models
Please see the Wiki pages for implementation details.
| Name | Key | Relations | Scopes |
|---|---|---|---|
| GeonamesGeoname | geoname_id | alternateName, timeZone,country | admin1,city,countryInfo |
| GeonamesAlternateName | geoname_id | geoname | |
| GeonamesCountryInfo | iso | timezone,continent | |
| GeonamesFeatureCode | code | ||
| GeonamesLanguageCode | iso_639_3 | ||
| GeonamesTimezone | timezone_id | ||
| GeonamesHierarchy | parent_id | ||
| GeonamesAdmin1Code | geoname_id | geoname,hierarchies | |
| GeonamesAdmin2Code | geoname_id | geoname,hierarchies |
Tables
GeoNames file names and corresponding table names created in your database.
| Filename | Tablename |
|---|---|
| timeZones.txt | geonames_timezones |
| allCountries.zip | geonames_geonames |
| countryInfo.txt | geonames_country_infos |
| iso-languagecodes.txt | geonames_language_codes |
| alternateNames.zip | geonames_alternate_names |
| hierarchy.zip | geonames_hierarchies |
| admin1CodesASCII.txt | geonames_admin1_codes |
| admin2Codes.txt | geonames_admin2_codes |
| featureCodes_en.txt | geonames_feature_codes |
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Credits
License
The MIT License (MIT). Please see License File for more information.