geobase/php-countries

<p align="center"><img width="320"src="https://cdn.rawgit.com/geobase/countries/master/logo.png"></p>

<p align="center">
  <a href="https://travis-ci.org/geobase/php-countries"><img src="https://img.shields.io/travis/geobase/php-countries.svg?style=flat-square" alt="Build Status"></a>
  <a href="https://styleci.io/repos/26692561"><img src="https://styleci.io/repos/26692561/shield" alt="StyleCI"></a>
  <a href="https://scrutinizer-ci.com/g/geobase/php-countries/?branch=master"><img src="https://img.shields.io/scrutinizer/g/geobase/php-countries.svg?style=flat-square" alt="Scrutinizer Code Quality"></a>
  <a href="https://scrutinizer-ci.com/g/geobase/php-countries/?branch=master"><img src="https://img.shields.io/scrutinizer/coverage/g/geobase/php-countries.svg?style=flat-square" alt="Code Coverage"></a>
  <a href="https://codeclimate.com/github/geobase/php-countries"><img src="https://img.shields.io/codeclimate/github/geobase/php-countries.svg?style=flat-square" alt="Code Climate"></a>
  <a href="https://packagist.org/packages/geobase/countries"><img src="https://img.shields.io/packagist/v/geobase/countries.svg?style=flat-square" alt="Latest Stable Version"></a>
</p>

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

1. [Features](#features)
2. [Sources](#sources)
3. [Requirements](#requirements)
4. [Installation](#installation)
5. [Country](#country)
6. [Region](#region)

## Features

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

## Sources

 * [GeoNames](http://www.geonames.org/)
 * [Wikipedia](http://en.wikipedia.org/)
 * [OpenStreetMap](http://www.openstreetmap.org/)

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

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

Get country name in english.

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

Order by country name in english.

```php
$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.

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

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

Get region name and type in english.

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