Upgrading to v4 from v2

There is no v3: every Laranex package moved to v4.0.0 together, so this release follows v2.0.0 directly.

Requirements

PHP 8.1+ and Laravel 10 to 13.

composer require laranex/laravel-myanmar-nrc:^4.0

Facade and methods

The parser is Laranex\LaravelMyanmarNRC\MyanmarNrc, bound as a singleton under its class name. The laravel-myanmar-nrc container binding is gone.

Before	After
Laranex\LaravelMyanmarNRC\LaravelMyanmarNrcFacade (alias LaravelMyanmarNrc)	Laranex\LaravelMyanmarNRC\Facades\MyanmarNrc (alias MyanmarNrc)
LaravelMyanmarNrc::parseNRC($nrc, $dbDriven, $lang)	MyanmarNrc::parse($nrc, $dbDriven, $lang)
(new LaravelMyanmarNrc)->isValidMyanmarNRC($nrc)	MyanmarNrc::isValid($nrc)
LaravelMyanmarNrcServiceProvider	MyanmarNrcServiceProvider (auto-discovered)
Console\SeedMyanmarNRCCommand	Console\Commands\SeedMyanmarNrcCommand (still mm-nrc:seed)
Data\MyanmarNRCJsonHandler	Repositories\JsonNrcRepository (resolve it from the container)

If you registered the provider manually, point it at Laranex\LaravelMyanmarNRC\MyanmarNrcServiceProvider.

JsonNrcRepository's types(), states() and townships() return the rows as arrays.

Backend selection

Passing $dbDriven = false now really selects the JSON backend. Before, db_driven => true in the config could not be overridden per call.

Exceptions

Invalid NRCs throw InvalidNrcException and an unknown language throws UnsupportedLocaleException (both extend InvalidArgumentException) instead of a bare Exception. Update your catch blocks:

use Laranex\LaravelMyanmarNRC\Exceptions\InvalidNrcException;

try {
    MyanmarNrc::parse($nrc);
} catch (InvalidNrcException) {
    // ...
}

An NRC must now have exactly four - separated parts.

isValid() only turns InvalidNrcException into false. v2's isValidMyanmarNRC() swallowed every exception, so errors such as a missing NRC table now surface instead of failing validation. isValid() no longer depends on the locale config, so an unsupported value there only affects parse().

Language code

Burmese uses the ISO 639-1 code my instead of mm. There is no mm alias: passing mm throws UnsupportedLocaleException.

Before	After
'locale' => 'mm' in config/laravel-myanmar-nrc.php	'locale' => 'my'
parseNRC($nrc, $dbDriven, 'mm')	MyanmarNrc::parse($nrc, $dbDriven, 'my')
lang/vendor/laravel-myanmar-nrc/mm (published translations)	lang/vendor/laravel-myanmar-nrc/my
code_mm and name_mm (columns, model attributes, JSON keys)	code_my and name_my

The validation message is translated for the application locale my. If a custom JSON file is set in json_file, rename its code_mm and name_mm keys too. NRC ids are unchanged, so stored NRCs keep validating.

Models

Before	After
State::nrcTownships()	State::townships()
Township::nrcTownship()	Township::state()

id, code (on State) and nrc_state_id are cast to integers.

Configuration

The config file is now published with --tag="laravel-myanmar-nrc-config" and the translations with --tag="laravel-myanmar-nrc-lang". The migrations can now be published with --tag="laravel-myanmar-nrc-migrations". --tag="laravel-myanmar-nrc" publishes all three.

json_file defaults to null (the bundled file). The old 'nrc.json' value still means the bundled file, which moved to resources/data/nrc.json.

Validation rule

MyanmarNRC is now a ValidationRule. It accepts an optional dbDriven constructor argument, and its message can be overridden through the custom messages array ('nrc.'.MyanmarNRC::class).

Database

The migrations keep their file names, so they do not run again on existing installations, and the v2 tables still have code_mm and name_mm columns. Add a migration to your application that renames them:

php artisan make:migration rename_nrc_mm_columns_to_my

<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
    public function up(): void
    {
        foreach (['nrc_states', 'nrc_townships', 'nrc_types'] as $table) {
            if (! Schema::hasColumn($table, 'code_mm')) {
                continue;
            }

            Schema::table($table, function (Blueprint $table): void {
                $table->renameColumn('code_mm', 'code_my');
                $table->renameColumn('name_mm', 'name_my');
            });
        }
    }
};

The hasColumn check makes it a no-op on fresh databases, where the package migrations already create code_my and name_my. On Laravel 10, renaming a column on MySQL older than 8.0.3, MariaDB older than 10.5.2 or SQLite older than 3.25 needs doctrine/dbal. If you published the package migrations, change code_mm and name_mm to code_my and name_my in your copies as well.

Then run the migration and re-seed once to refresh the data. mm-nrc:seed keeps its name and no longer uses MySQL-only SET FOREIGN_KEY_CHECKS:

php artisan migrate
php artisan mm-nrc:seed