kodegrenade / naija-faker-laravel
A Laravel faker library to generate typical Nigeria fake data ranging from name, address, phone number, LGAs and states for you. It supports Yoruba, Igbo, and Hausa ethnic groups with culturally authentic data.
Package info
github.com/kodegrenade/naija-faker-laravel
pkg:composer/kodegrenade/naija-faker-laravel
Requires (Dev)
- php: >=8.2
- illuminate/support: ^11.0@dev
- pestphp/pest: 2.x-dev
- pestphp/pest-plugin-drift: 2.x-dev
- phpunit/phpunit: ^8.4|^10.0
README
Introduction ๐
A comprehensive package that generates fake, culturally authentic Nigerian data โ names, addresses, phone numbers, bank accounts, universities, companies, and much more. Supports three major ethnic groups: Yoruba, Igbo, and Hausa.
NB: Nigeria as a country has so many languages.
Yoruba,IgboandHausaare 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 |-------------------------------------------------------------------------- */ 'providers' => [ ... Kodegrenade\NaijaFaker\NaijaFakerServiceProvider::class, ]; ...
Add alias to the config/app.php file
'aliases' => [ ... 'NaijaFaker' => Kodegrenade\NaijaFaker\NaijaFaker::class, ]; ...
Usage ๐งจ
NOTE All methods return associative arrays or strings.
Seeded / Deterministic Mode
Set a seed for reproducible output (useful for testing):
<?php NaijaFaker::seed(12345); $name1 = NaijaFaker::name(); // always the same NaijaFaker::seed(null); // reset to random mode
Configuration
Set default language, gender, or network:
<?php NaijaFaker::config([ 'language' => 'yoruba', 'gender' => 'male', 'network' => 'mtn', ]);
Person
Generate fake person data.
<?php NaijaFaker::person(string $language, string $gender);
Sample
$person = NaijaFaker::person('yoruba', 'male');
[ 'title' => 'Engr.', 'firstName' => 'Akintunde', 'lastName' => 'Owoyele', 'fullName' => 'Akintunde Owoyele', 'email' => 'akintunde.owoyele@gmail.com', 'phone' => '+2349093636382', 'address' => 'Plot 63, Ebubedike Uzoma Avenue, Awka', ]
People
Generate multiple fake people.
<?php NaijaFaker::people(int $count = 10, string $language, string $gender);
Name
Generate a fake name.
<?php $name = NaijaFaker::name('hausa', 'male'); // => "Ahmed Maikudi"
Title
Generate a fake Nigerian title.
<?php $title = NaijaFaker::title('male'); // => "Chief"
Email Address
Generate a fake email address.
<?php $email = NaijaFaker::email('Temitope Ayotunde'); // => "temitope.ayotunde@gmail.com" $email = NaijaFaker::email('Temitope Ayotunde', 'workplace.com'); // => "temitopeayotunde@workplace.com"
Address
Generate a fake Nigerian address.
<?php $address = NaijaFaker::address(); // => "Plot 45, Oluwaseun Adedayo Street, Ibadan"
Phone Number
Generate a fake Nigerian phone number.
<?php NaijaFaker::phoneNumber(string $network);
NOTE: Supported networks are
mtn,glo,9mobile&airtel
$phone = NaijaFaker::phoneNumber('mtn'); // => "+2347037653761"
States & LGAs
<?php $states = NaijaFaker::states(); // all 37 Nigerian states $lgas = NaijaFaker::lgas(); // all 774 LGAs
Identity & Financial
BVN (Bank Verification Number)
$bvn = NaijaFaker::bvn(); // => "22345678901"
NIN (National Identification Number)
$nin = NaijaFaker::nin(); // => "12345678901"
Bank Account
$account = NaijaFaker::bankAccount(); // => ['bankName' => 'Access Bank', 'bankCode' => '044', 'accountNumber' => '1234567890'] $account = NaijaFaker::bankAccount('Zenith Bank'); // => ['bankName' => 'Zenith Bank', 'bankCode' => '057', 'accountNumber' => '0987654321']
Geographic Consistency
Generate persons where name ethnicity, state, and LGA all match geographically.
Consistent Person
$person = NaijaFaker::consistentPerson('yoruba', 'male');
[ 'title' => 'Chief', 'firstName' => 'Adebayo', 'lastName' => 'Ogunlesi', 'fullName' => 'Adebayo Ogunlesi', 'email' => 'adebayo.ogunlesi@gmail.com', 'phone' => '+2348031234567', 'address' => 'Plot 45, Oluwaseun Adedayo Street, Ibadan', 'state' => 'Oyo', // matches Yoruba region 'lga' => 'Ibadan North', // belongs to Oyo state ]
Consistent People
$people = NaijaFaker::consistentPeople(5, 'igbo', 'female');
Records
License Plate
$plate = NaijaFaker::licensePlate(); // => "KAN-234XY" $plate = NaijaFaker::licensePlate('Lagos'); // => "LAG-567AB"
Company
$company = NaijaFaker::company(); // => ['name' => 'Pan-African Technologies Ltd', 'rcNumber' => 'RC-456789', 'industry' => 'Technology']
University
$uni = NaijaFaker::university(); // => ['name' => 'University of Lagos', 'abbreviation' => 'UNILAG', 'state' => 'Lagos', 'type' => 'federal']
Education Record
$edu = NaijaFaker::educationRecord('yoruba'); // => ['university' => 'University of Ibadan', 'abbreviation' => 'UI', 'degree' => 'B.Sc', 'course' => 'Computer Science', 'graduationYear' => 2019]
Work Record
$work = NaijaFaker::workRecord(); // => ['company' => 'Global Finance Holdings', 'position' => 'Software Engineer', 'industry' => 'Technology', 'startYear' => 2020]
Vehicle Record
$vehicle = NaijaFaker::vehicleRecord('Lagos'); // => ['licensePlate' => 'LAG-234XY', 'make' => 'Toyota', 'model' => 'Corolla', 'year' => 2021, 'color' => 'Silver']
Personal Data
Date of Birth
$dob = NaijaFaker::dateOfBirth(); // => ['date' => '1990-03-15', 'age' => 35] $dob = NaijaFaker::dateOfBirth(['minAge' => 25, 'maxAge' => 40]);
Marital Status
$status = NaijaFaker::maritalStatus(); // => "Married"
Blood Group & Genotype
$bg = NaijaFaker::bloodGroup(); // => "O+" $gt = NaijaFaker::genotype(); // => "AA"
Salary
$salary = NaijaFaker::salary(); // => ['amount' => 450000, 'currency' => 'NGN', 'level' => 'mid', 'frequency' => 'monthly'] $salary = NaijaFaker::salary(['level' => 'senior']);
Next of Kin
$kin = NaijaFaker::nextOfKin('yoruba', 'female'); // => ['fullName' => 'Folake Adeyemi', 'relationship' => 'Sister', 'phone' => '+234...', 'address' => '...']
Detailed Person
Generate a complete identity with person, personal data, education, work, and vehicle all in one call:
$person = NaijaFaker::detailedPerson('yoruba', 'male');
[ // Person 'title' => 'Chief', 'firstName' => 'Adebayo', 'lastName' => 'Ogunlesi', 'fullName' => 'Adebayo Ogunlesi', 'email' => 'adebayo.ogunlesi@gmail.com', 'phone' => '+2348031234567', 'address' => 'Plot 45, Oluwaseun Street, Ibadan', 'state' => 'Oyo', 'lga' => 'Ibadan North', // Personal 'dateOfBirth' => ['date' => '1990-03-15', 'age' => 35], 'maritalStatus' => 'Married', 'bloodGroup' => 'O+', 'genotype' => 'AA', 'salary' => ['amount' => 450000, 'currency' => 'NGN', 'level' => 'mid', 'frequency' => 'monthly'], 'nextOfKin' => ['fullName' => 'Folake Adeyemi', 'relationship' => 'Spouse', 'phone' => '...', 'address' => '...'], // Records 'education' => ['university' => 'University of Ibadan', 'abbreviation' => 'UI', 'degree' => 'B.Sc', 'course' => 'Computer Science', 'graduationYear' => 2019], 'work' => ['company' => 'Pan-African Solutions Ltd', 'position' => 'Software Engineer', 'industry' => 'Technology', 'startYear' => 2020], 'vehicle' => ['licensePlate' => 'OYO-234XY', 'make' => 'Toyota', 'model' => 'Corolla', 'year' => 2021, 'color' => 'Silver'], ]
$people = NaijaFaker::detailedPeople(5, 'igbo');
Export
Export generated data as JSON or CSV:
$json = NaijaFaker::export('person', 10, 'json'); $csv = NaijaFaker::export('detailedPerson', 5, 'csv'); $csv = NaijaFaker::export('consistentPerson', 10, 'csv');
CSV output uses dot notation for nested fields (e.g., education.university, salary.amount).
Custom Providers
Register your own data generators:
// Register NaijaFaker::registerProvider('religion', function ($faker) { $religions = ['Christianity', 'Islam', 'Traditional']; return $religions[array_rand($religions)]; }); // Use NaijaFaker::generate('religion'); // => "Islam" // List all registered NaijaFaker::listProviders(); // => ['religion']
NOTE: Custom providers cannot override built-in methods.
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 brhamix@gmail.com