README

Naija is a PHP package that provides data about States, Local Government Areas, cities, and towns in Nigeria.

This package is inspired by https://github.com/Mercyware/Nigerian-States.

With this package you can retrieve the following state-related information:

Name
Capital
Political Zone
Creation Date
Population - Male and female
Website
Logo
Flag
Nick Name
Languages
Local Governments Areas
Areas - villages, towns, and cities

Usage

Install via:

    composer require emmadonjo/naija

use Emmadonjo\Naija\Naija;

// get list of states with minimal information
$states = Naija::states();

// get the comprehensive information of a state
$state = Naija::state('Abia');

// get all the attributes of a state
$state->getAttributes();

// get name
$state->getName();

// get nickname
$state->getNickName();

// get official name
$state->getOfficialName();

// get short code
$state->getShortCode();

// get capital
$state->getCapital();

// get geo political zone
$state->getGeoPoliticalZone();

// get date created
$state->getDateCreated();

// get population
$state->getPopulation();

// get website
$state->getWebsite();

// get logo
$state->getLogo();

// get flag
$state->getFlag();


// get languages
$state->getLanguages();

// get LGAs
$state->getLgas();

// get areas - villages, cities, and towns
$state->getAreas();

Display assets - logos and flags To display logos and flags of states, you can copy the assets to the images folder in the accessible location of your application.

For example, if you are developing with laravel, copy:

resources/logos to public/images/logos, and
resources/flags to public/images/flags

Then you can access the assets as follows:

/images/logos/abia.png
/images/flags/abia.png

Contributing

Contributions are welcome — whether that's fixing or filling in a state's LGA/area data, or improving the PHP API. See CONTRIBUTING.md for the data format, sourcing requirements, and how to run the test suite.

Sources

General

Abia State

Adamawa State

Akwa Ibom State

Anambra State

Bauchi State

Bayelsa State

Benue State

Borno State

Cross River State

Delta State

emmadonjo / naija

Maintainers

Package info

Statistics

Security

README

Usage

Contributing

Sources

General

Abia State

Adamawa State

Akwa Ibom State

Anambra State

Bauchi State

Bayelsa State

Benue State

Borno State

Cross River State

Delta State

Ebonyi State

Edo State

Ekiti State

Enugu State

Federal Capital Territory

Gombe State

Imo State

Jigawa State

Kaduna State

Kano State

Katsina State

Kebbi State

Kogi State

Kwara State

Lagos State

Nasarawa State

Niger State

Ogun State

Ondo State

Osun State

Oyo State

Plateau State

Rivers State

Sokoto State

Taraba State

Zamfara State

Yobe State