kodegrenade/naija-faker-laravel

A simple package that generates fake typical Nigerian data.

v1.0.1 2023-10-04 00:25 UTC

Requires (Dev)

• illuminate/support: ^11.0@dev
• pestphp/pest: 2.x-dev
• pestphp/pest-plugin-drift: 2.x-dev
• phpunit/phpunit: ^8.4|^10.0

MIT

• Temitope Ayotunde

• package
• php
• faker
• github
• laravel
• open source
• naija-faker

README

Introduction 👋

This is a simple package that generates fake typical Nigerian data ranging from name, address, phone number, lgas and states. This can be used mostly for generating fake data for your application.

NB: Nigeria as a country has some many languages. Yoruba, Igbo and Hausa are the only languages supported at the moment.

Installation

Install via composer

composer require kodegrenade/naija-faker-laravel

Add service provider to the config/app.php file

<?php
  /*
  |--------------------------------------------------------------------------
  | Autoloaded Service Providers
  |--------------------------------------------------------------------------
  |
  | The service providers listed here will be automatically loaded on the
  | request to your application. Feel free to add your own services to
  | this array to grant expanded functionality to your applications.
  |
  */

  'providers' => [
    ...
    Kodegrenade\NaijaFaker\OtpServiceProvider::class,
  ];
...

Add alias to the config/app.php file

  /*
  |--------------------------------------------------------------------------
  | Class Aliases
  |--------------------------------------------------------------------------
  |
  | This array of class aliases will be registered when this application
  | is started. However, feel free to register as many as you wish as
  | the aliases are "lazy" loaded so they don't hinder performance.
  |
  */

  'aliases' => [
    ...
    'NaijaFaker' => Kodegrenade\NaijaFaker\NaijaFaker::class,
  ];
...

Usage 🧨

NOTE
Response are returned as objects or array depending on the method used.

Person

Generate fake person data by calling the person faker method.

<?php

NaijaFaker::person(string $language, string $gender);

• $language (optional | default = random value): The language of the fake person's data to be generated.
• $gender (optional | default = random value): The gender of the person's data to be generate.

Sample

<?php

$person = NaijaFaker::person('yoruba', 'male');

This will generate a fake person data with yoruba names.

{
  "title": 'Engr.',
  "firstName": 'Akintunde',
  "lastName": 'Owoyele',
  "fullName": 'Akintunde Owoyele',
  "email": '[e-mail]',
  "phone": '[phone]',
  "address": '63, Ebubedike Uzoma Avenue, Awka'
}

People

Generate fake people data by calling the people faker method.

<?php

NaijaFaker::people(int $number = 5, string $language, string $gender);

• $number (optional | default = 5): The number of person's to be added to the people list.
• $language (optional | default = random value): The language of the fake persons data to be generated in the people list.
• $gender (optional | default = random value): The gender of the people to be generate.

Sample

<?php

$people = NaijaFaker::people(3, 'igbo', 'female');

This will generate three (3) female fake persons with igbo names.

[
  {
    "title" => "Dr."
    "fullname" => "Chinweuba Enyinnaya"
    "gender" => "Female"
    "email" => "[e-mail]"
    "phone" => "[phone]"       
    "address" => "86 Crescent Itu, Imo"
  },
  {
    "title" => "Prof."
    "fullname" => "Akachukwu Ndubisi"
    "gender" => "Female"
    "email" => "[e-mail]"
    "phone" => "[phone]"
    "address" => "199 Avenue Ilobu, Oyo"
  },
  {
    "title" => "Mrs."
    "fullname" => "Ngozi Zeribe"
    "gender" => "Female"
    "email" => "[e-mail]"
    "phone" => "[phone]"
    "address" => "156 Crescent Bonny, Bayelsa"
  }
]

Name

Generate fake name.

<?php

NaijaFaker::name(string $language, string $gender);

• $language (optional | default = random value): The language of the fake name to be generated.
• $gender (optional | default = random value): The gender of the name to be generated.

Sample

<?php

$name = NaijaFaker::name('hausa', 'male');

This will generate fake male Hausa name.

Ahmed Maikudi

Title

Generate fake title.

<?php

NaijaFaker::title(string $gender);

• $gender (optional | default = random value): The gender of the title to be generated.

Sample

<?php

$name = NaijaFaker::title('male');

This will generate fake male title.

Mr.

Email Address

Generate fake email address.

<?php

NaijaFaker::email(string $name, string $extension);

• $name: The name of the email address to be generated.
• $extension (optional | default = random value): The domain extension of the email address.

Sample

<?php

# without domain extension
$email = NaijaFaker::email('Temitope Ayotunde');

# with domain extension
$email = NaijaFaker::email('Temitope Ayotunde', 'workplace.com');

This will generate fake email address.

# without extenstion
[e-mail]

# with extension
[e-mail]

Address

Generate fake house address.

<?php

NaijaFaker::address();

Sample

<?php

$address = NaijaFaker::address();

This will generate fake email address.

188 Crescent Bori City, Enugu

Phone Number

Generate phone number.

<?php

NaijaFaker::phoneNumber(string $network);

• $network (optional | default = random value): The network of the phone number to be generated.

NOTE
Supported networks are Mtn, Glo, 9mobile & Airtel

Sample

<?php

$email = NaijaFaker::phoneNumber('mtn');

This will generate phone number.

[phone]

States

Generate nigerian states.

<?php

NaijaFaker::states();

Sample

<?php

$states = NaijaFaker::states();

This will return all the Nigerian states.

[
  "Abia",
  "Adamawa",
  "Akwa Ibom",
  "Anambra",
  "Bauchi",
  "Bayelsa",
  "Benue",
  "Borno",
  "Cross River",
  "Delta",
  "Ebonyi",
  ...
]

LGAs

Generate Nigerian Local Government Areas.

<?php

NaijaFaker::lgas();

Sample

<?php

$states = NaijaFaker::lgas();

This will return all the Nigerian Local Government Areas.

[
  "Aba North",
  "Aba South",
  "Arochukwu",
  "Bende",
  "Ikwuano",
  "Isiala Ngwa North",
  "Isiala Ngwa South",
  "Isuikwuato",
  "Obi Ngwa",
  "Ohafia",
  "Osisioma",
  "Ugwunagbo",
  "Ukwa East",
  "Ukwa West",
  "Umuahia North",
  "Umuahia South",
  "Umu Nneochi",
  "Demsa",
  "Fufure",
  "Ganye",
  "Gayuk",
  "Gombi",
  "Grie",
  "Hong",
  ...
]

Quick Usage

You can give the package a quick spin by running the following artisan command:

php artisan faker:generator

Tests

composer test tests

Disclaimer ⚠️

See DISCLAIMER for details.

Contribution

Please feel free to fork the package and contribute by submitting a pull request to enhance the functionalities.

License

Naija Faker is release under the MIT License. See LICENSE for details.

Feedback

If you have any feedback, please reach out to me at [e-mail]

Author

• @kodegrenade