Skip to content

Data from Open Data providers compiled into easy to use PHP objects

License

Notifications You must be signed in to change notification settings

geobase/php-countries

Repository files navigation

Build Status StyleCI Scrutinizer Code Quality Code Coverage Code Climate Latest Stable Version

Data from Open Data providers compiled into easy to use PHP objects Edit

  1. Features
  2. Sources
  3. Requirements
  4. Installation
  5. Country
  6. Region

Features

  • Multiple languages (Currently only supports English, French and German).
  • Country Database
  • Region Database (Currently only for Canada and the United States).

Sources

Requirements

This library does not require a database, but instead, uses JSON files.

This library uses PHP 5.6+.

Installation

You need to install the library through composer. To do so, use the following command

composer require geobase/countries

Country

Database of all countries in the world.

Properties

  • Names
  • Short Code (Alpha-2 code)
  • Code (Alpha-3 code)
  • Latitude
  • Longitude
  • Bounding Box
  • Currency
  • Continent
  • Population
  • Area
  • Capital
  • Timezone

Examples

Get a list of all countries.

use GeoBase\Country\CountryRepository;
$countryCollection = CountryRepository::findAll();

Get country name in english.

foreach ($countryCollection as $country) {
   echo $country->getNames()->get('en');
}

Order by country name in english.

$countryCollection->orderByName();

Region

Database of all States, Federal Districts and Territories in the United States, Provinces and Territories in Canada.

Properties

  • Name
  • Code (Alpha-2 code)
  • Country
  • Type
  • Latitude
  • Longitude
  • Bounding Box

Examples

Get a list of all regions in the US.

use GeoBase\Country\CountryRepository;
use GeoBase\Regions\RegionRepository;

$country = CountryRepository::findByCode('US');
$regionCollection = RegionRepository::findByCountry($country);

Get region name and type in english.

foreach ($regionCollection as $region) {
   echo $region->getNames()->get('en') . " is a " . 
       $region->getType()::class . " of the " . 
       $country->getNames()->get('en);
}

About

Data from Open Data providers compiled into easy to use PHP objects

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages