Search by

xefi / faker-php-locales-en-nz

martinsoenen

Faker extension to include en_NZ locale

Package info

github.com/xefi/faker-php-locales-en-nz

pkg:composer/xefi/faker-php-locales-en-nz

Statistics

Installs: 5

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

v1.0.1 2026-11-18 10:21 UTC

This package is auto-updated.

Last update: 2026-11-18 11:07:28 UTC


README

New Zealand English (en_NZ) locale for Faker PHP.

Installation

composer require --dev xefi/faker-php-locales-en-nz

The service provider is discovered automatically through Composer.

Usage

use Xefi\Faker\Faker;

$faker = new Faker('en_NZ');

Generators without a en_NZ variant fall back to the default locale.

Locale-specific generators

$faker->region();         // 'Canterbury'
$faker->postcode();       // '8011'
$faker->irdNumber();      // IRD number, valid modulus 11 check digit
$faker->nzbn();           // New Zealand Business Number, valid GS1 check digit
$faker->companyNumber();  // Companies Office number

New Zealand does not use IBAN: iban() returns an IBAN-shaped NZ string built from a bank, branch, account and suffix.

Contributing

  1. Fork the repository and create a branch from main.
  2. Add an extension under src/Extensions/ and register it in FakerEnNzServiceProvider::boot().
  3. Add a test under tests/Unit/.
  4. Run the suite with vendor/bin/phpunit (or docker compose run php vendor/bin/phpunit).
  5. Open a pull request against main.

License

MIT