emmadonjo/naija

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

Maintainers

Details

github.com/emmadonjo/naija

Source

Issues

Installs: 11

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 1

Forks: 0

Open Issues: 0

v1.0.2 2024-09-25 11:28 UTC

Requires

  • php: >=8

Requires (Dev)

MIT 0d4f81982c0a7c0c21672219bf677bf926c6cc34

  • Joshua Emmanuel <jo4christ48.woop@yahoo.com>

This package is auto-updated.

Last update: 2024-11-25 11:46:35 UTC

README

Build Status Total Downloads Latest Stable Version License

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
  • Polution - 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 name
$state->getName();

// get nick name
$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

To Do

  • Populate areas (villages, cities, and towns) for most of the remaining states

Sources