Download the PHP package tocaan/world without Composer
On this page you can find all versions of the php package tocaan/world. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package world
Short Description Laravel countries, states, cities and currencies
License MIT
Homepage https://github.com/Tocaanco/world.git
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package world
The World is a Laravel package which provides a list of the countries, states, cities, timezones, currencies and languages.
It can be consumed with the World Facade or the defined Api routes.
Installation
Upgrading to v1.1.12?
- New addition:
searchargument. - New addition: The allowed countries and disallowed countries arrays in config. This new addition by @aeq-dev is to help restrict the seeding of the countries and their dependencies.
- If you are upgrading from a version older than 1.1.10 and due to the changes in the routes and config files, re-publish the package assets by issuing the command
php artisan vendor:publish --tag=world --force - If needed, customize the table names and enable or disabled the optional database fields in the
world.phpconfig file. - The counties table sub_region field was renamed to subregion. It is advisable to refresh the migrations and seed the db tables.
Changelog
Please read CHANGELOG for more information of what was changed recently.
Contributing
Please read CONTRIBUTING for more details.
Demo
Please feel free to query https://laravel-world.com
Examples
https://laravel-world.com/api/countries
https://laravel-world.com/api/countries?search=rom
https://laravel-world.com/api/states?filters[country_code]=RO&fields=cities
Usage
List all the countries.
Use the World facade
Use the Api countries endpoint
Fetch a country with its states and cities.
Use the World facade
Use the Api countries endpoint
List all the cities by country id.
Use the Api cities endpoint
Available actions
| Name | Description |
|---|---|
| countries | lists all the world countries |
| states | lists all the states |
| cities | lists all the cities |
| timezones | lists all the timezones |
| currencies | lists all the currencies |
| languages | lists all the languages |
An action response is formed as below:
- success (boolean)
- message (string)
- data (instance of Illuminate\Support\Collection)
- errors (array)
Countries action
- fields*: comma seperated string(countries table fields in addition to states, cities, currency and timezones).
- filters*: array of keys(countries table fields) and their corresponding values.
- search*: string.
States action
- fields*: comma seperated string(states table fields in addition to country and states).
- filters*: array of keys(states table fields) and their corresponding values.
- search*: string.
Cities action
- fields*: comma seperated string(cities table fields in addition to country and state).
- filters*: array of keys(cities table fields) and their corresponding values.
- search*: string.
Timezones action
- fields*: comma seperated string(timezones table fields in addition to country).
- filters*: array of keys(timezones table fields) and their corresponding values.
- search*: string.
Currencies action
- fields*: comma seperated string(currencies table fields in addition to country).
- filters*: array of keys(currencies table fields) and their corresponding values.
- search*: string.
Languages action
- fields*: comma seperated string(languages table fields).
- filters*: array of keys(languages table fields) and their corresponding values.
- search*: string.
Available Api routes
All routes can be prefixed by any string. Ex admin, api, api ...
Countries
| Method | GET |
| Route | /{prefix}/countries |
| Parameters* | comma seperated fields(countries table fields in addition to states, cities, currency and timezones), array filters, string search |
| Example | /api/countries?fields=iso2,cities&filters[phone_code]=44 |
| response | success, message, data |
States
| Method | GET |
| Route | /{prefix}/states |
| Parameters* | comma seperated fields(states table fields in addition to country and cities), array filters, string search |
| Example | /api/states?fields=country,cities&filters[country_code]=RO |
| response | success, message, data |
Cities
| Method | GET |
| Route | /{prefix}/cities |
| Parameters* | comma seperated fields(states table fields in addition to country and state), array filters, string search |
| Example | /api/cities?fields=country,state&filters[country_code]=RO |
| response | success, message, data |
Timezones
| Method | GET |
| Route | /{prefix}/timezones |
| Parameters* | comma seperated fields(states table fields in addition to the country), array filters, string search |
| Example | /api/timezones?fields=country&filters[country_code]=RO |
| response | success, message, data |
Currencies
| Method | GET |
| Route | /{prefix}/currencies |
| Parameters* | comma seperated fields(states table fields in addition to the country), array filters, string search |
| Example | /api/timezones?fields=country&filters[country_code]=RO |
| response | success, message, data |
Languages
| Method | GET |
| Route | /{prefix}/languages |
| Parameters* | comma seperated fields, string search |
| Example | /api/languages?fields=dir |
| response | success, message, data |
Localization
The available locales are ar, bn, br, de, en, es, fr, ja, kr, nl, pl, pt, ro, ru and zh.
The default locale is en.
Include in the request header
Alternativley, you can use specific locale with the World Facade setLocale('locale') helper method. Example:
Schema
Configuration
The configuration of the world package is in the world.php config file.
If you are upgrading from a previous version, you should consider re-publishing the file by issuing:
Supported Locales
A list of the accepted locales which relate to the localized lang files.
Modules enablement
The states, cities, timezones, currencies and languages modules can be optionally disabled.
Please note that the cities module depends on the states module.
Routes
If you don't wish to use the packages as an api service, you can disable all the routes by assigning false to routes.
Migrations
It offers the ability to enable or disable the database fields.
When changing this configuration the database should be dropped and the seeder should be re-run.
Testing
Requirements
- The database is seeded.
- The database connection is defined in the .env file.
Browse to the package root folder and run:
* optional
