signdeer/world

Laravel countries, states, cities and currencies

v1.0.5 2025-07-02 21:49 UTC

Requires

• php: >=7.4

Requires (Dev)

• orchestra/testbench: >=v4.0.0
• phpunit/phpunit: >=8.5.8

MIT

• Imran V. Mungai

• laravel
• states
• countries
• currencies
• cities
• timezones
• lumen

README

This fork is maintained by Signdeer, a secure, modern platform for e-signatures, approvals, and digital document workflows built for African teams and global standards.

The World is a Laravel package that provides a comprehensive list of countries, states, cities, timezones, currencies, and languages. You can access the data using the World Facade or through defined API routes.

Table of Contents

• Installation
  • Automated Installation
  • Manual Installation
• What's New in v1.1.35
• Changelog
• Contributing
• Examples
• Usage
  • List All Countries
  • Fetch Country with States & Cities
  • List All Cities by Country ID
• Available Actions
• Available API Routes
  • Countries
  • States
  • Cities
  • Timezones
  • Currencies
  • Languages
• Localization
• Schema
• Configuration
• Testing

Installation

First, set your application environment to local:

set APP_ENV=local

Then, install the package via composer:

composer require nnjeim/world

Optionally, set the WORLD_DB_CONNECTION environment variable to your desired database connection.

Automated Installation

Run the following Artisan command to automate the installation process:

php artisan world:install

Manual Installation

If you prefer to install the package manually, follow these steps:

1. Publish the package configuration file:

php artisan vendor:publish --tag=world --force

1. Run the migrations:

php artisan migrate 

1. Seed the database:

php artisan db:seed --class=WorldSeeder

Upgrading

If you're upgrading from a previous version, you may want to re-publish the config file:

php artisan vendor:publish --tag=world --force

What's new in v1.1.35?

• Addition of the azerbaijani localization by @elnurvl.

Changelog

For detailed information on recent changes, please see the CHANGELOG.

Contributing

We welcome contributions! For details on how to get started, please review our CONTRIBUTING guidlines.

Examples

Explore the API examples on our live site:

List all countries:
https://world.bmbc.cloud/api/countries
Search for a country:
https://world.bmbc.cloud/api/countries?search=rom
Get states by country code:
https://world.bmbc.cloud/api/states?filters[country_code]=RO&fields=cities

Usage

List all the countries

Use the World facade:

use Nnjeim\World\World;

$action =  World::countries();

if ($action->success) {
  $countries = $action->data;
}

response (object)
{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Afghanistan"
    },
    {
      "id": 2,
      "name": "Åland Islands"
    },
    .
    .
    .
  ],
}

Use the API countries endpoint:

https://myDomain.local/api/countries

Fetch a country with its states and cities.

Use the World facade:

use Nnjeim\World\World;

$action =  World::countries([
	'fields' => 'states,cities',
	'filters' => [
		'iso2' => 'FR',
	]
]);

if ($action->success) {

	$countries = $action->data;
}

Response:

(object)
{
  "success": true,
  "data": [
    "id": 77,
    "name": "France",
    "states": [
        {
          "id": 1271,
          "name": "Alo"
        },
        {
          "id": 1272,
          "name": "Alsace"
        },
        .
        .
        .
    ],
    "cities": [
        {
          "id": 25148,
          "name": "Abondance"
        },
        {
          "id": 25149,
          "name": "Abrest"
        },
        .
        .
        .
      ]
    ],
}

Use the API countries endpoint:

https://myDomain.local/api/countries?fields=states,cities&filters[iso2]=FR

List all the cities by country id

use Nnjeim\World\WorldHelper;

new class {
    protected $world;
    
    public function __construct(WorldHelper $world) {
        $this->world = $world;
    }
    
    $action = $this->world->cities([
        'filters' => [
            'country_id' => 182,
        ],
    ]);
    
    if ($action->success) {
        $cities = $action->data;
    }
}

Use the API cities endpoint:

https://myDomain.local/api/cities?filters[country_code]=RO 

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...

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 (cities 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 (timezones 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 (currencies table fields in addition to the country), array filters, string search
Example	/api/currencies?fields=code&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, az, bn, br, de, en, es, fr, it, ja, kr, nl, pl, pt, ro, ru, tr and zh.  

The default locale is en.

Header option

accept-language=locale

Alternatively, you can use specific locale with the World Facade setLocale('locale') helper method. Example:

World::setLocale('zh')->countries();

Schema

Configuration

The configuration for the World package is located in the world.php file.
If you're upgrading from a previous version, you may want to re-publish the config file:

php artisan vendor:publish --tag=world --force

Customizing database connection

By default, this package uses the default database connection, but it's possible to customize it using the WORLD_DB_CONNECTION variable in your .env file.

Countries restrictions

Countries can be restricted while seeding the database either by adding the ISO2 country codes in the allowed_countries or disallowed_countries array lists.

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:

composer install # installs the package dev dependencies
composer test

* optional