A PHP library for country and subdivision data.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
data
docs/1.0.0
src
.gitignore
.travis-phpunit.xml
.travis.yml
CONTRIBUTE.md
LICENSE
README.md
composer.json
phpunit.xml.dist
sami.php
update.php

README.md

Country

Build Status Coverage Status Latest Stable Version Total Downloads

A PHP library for country and subdivision data.

Usage

use Phine\Country\Loader\Loader;

$loader = new Loader();

// returns data for "US"
$country = $loader->loadCountry('US');

echo $country->getAlpha2Code(); // "US"
echo $country->getAlpha3Code(); // "USA"
echo $country->getLongName(); // "United States of America"
echo $country->getNumericCode(); // "840"
echo $country->getShortName(); // "United States"

// returns all countries
$countries = $loader->loadCountries();

$country = $countries['US'];

// returns data for "US-CA"
$subdivision = $loader->loadSubdivision('US-CA');

echo $subdivision->getCode(); // "US-CA"
echo $subdivision->getName(); // "California"

// returns all subdivisions
$subdivisions = $loader->loadSubdivisions();

$subdivision = $subdivisions['US-CA'];

// returns all subdivisions for a specific country
$subdivisions = $loader->loadSubdivisions('US');

Requirement

Installation

Via Composer:

$ composer require "phine/country=~1.0"

Documentation

You can find the documentation in the docs/ directory.

License

This library is available under the MIT license.