Membuat Penomoran Kode Otomatis di Laravel

Pada artikel kali ini kita akan membahas bagaimana membuat kode otomatis menggunakan Laravel. Kode otomatis disini adalah sebuah kode yang mengandung format tertentu, misalnya nomor invoice 2019.11.27/INV/0001.

AutoNumber package

Untuk membuat kode otomatis menggunakan Laravel, pada tutorial kali ini kita akan menggunakan sebuah package yaitu AutoNumber.

Dark Mode

laravel-autonumber (this link opens in a new window) by alfa6661 (this link opens in a new window)

Laravel package to create autonumber for Eloquent model

1 Subscriber 13 Watchers 6 Forks Check out this repository on GitHub.com (this link opens in a new window)

Instalasi

Kita bisa menginstal package ini dengan perintah composer.

composer require alfa6661/laravel-autonumber

Setelah itu, daftarkan package service provider pada file config/app.php.

'providers' => [
    // ...
    Alfa6661\AutoNumber\AutoNumberServiceProvider::class,
],

Publish config dan migration yang ada pada package ini.

php artisan vendor:publish --provider="Alfa6661\AutoNumber\AutoNumberServiceProvider"

Karena dalam package ini terdapat sebuah migration untuk membuat sebuah table, maka jalankan juga perintah migrate untuk membuat table tersebut.

php artisan migrate

Penggunaan

Untuk konfigurasi AutoNumber ada beberapa langkah yang harus kita gunakan pada model yang akan kita gunakan. Model yang akan kita gunakan harus mengimport sebuah trait yang sudah disediakan pada package ini Alfa6661\AutoNumber\AutoNumberTrait. Trait ini juga mengandung sebuah abstract method getAutoNumberOptions untuk mendefinisikan pengaturan format kode dan kolom yang mana yang akan kita gunakan untuk menyimpan kode otomatis ini, sehingga kita harus mengimplementasikan method ini pada model yang kita gunakan secara manual.

Contoh

use Alfa6661\AutoNumber\AutoNumberTrait;
    
class Order extends Model
{
    use AutoNumberTrait;
    
    /**
     * Return the autonumber configuration array for this model.
     *
     * @return array
     */
    public function getAutoNumberOptions()
    {
        return [
            'code' => [
                'format' => 'SO.?', // Format kode yang akan digunakan.
                'length' => 5 // Jumlah digit yang akan digunakan sebagai nomor urut
            ]
        ];
    }
}

Format kode akan otomatis digenerate pada saat kita menyimpan data menggunakan eloquent model.

$order = Order::create([
    'customer' => 'Alfa Adhitya',
]);

echo $order->code;
// SO.00001

Advanced Format

Terkadang kita diharuskan menggunakan format penomoran kode yang sedikit lebih rumit dibanding contoh diatas. Misalnya, SO/2019.11.27/BDG/00001

Untuk memenuhi format diatas, kita bisa menggunakan Closure pada value format.

public function getAutoNumberOptions()
{
    return [
        'code' => [
            'format' => function () {
                return 'SO/' . date('Y.m.d') . '/' . $this->branch . '/?'; 
            }
            'length' => 5,
        ]
    ];
}

Sama seperti contoh sebelumnya, kode penjualan akan otomatis digenerate pada saat data disimpan menggunakan eloquent model hanya saja dengan format yang berbeda.

Pada method getAutoNumberOptions, kita menggunakan Closure untuk konfigurasi format kode.

$order = Order::create([
    'customer' => 'Alfa Adhitya',
    'branch' => 'BDG',
]);

echo $order->code;
// SO/2019.11.27/BDG/00001

Dengan pengaturan penomoran kode diatas, ketika terjadi penjualan di cabang yang berbeda, nomor urut akan dimulai kembali dari 1.

$order = Order::create([
    'customer' => 'Alfa Adhitya',
    'branch' => 'JKT',
]);

echo $order->code;
// SO/2019.11.27/JKT/00001

Contoh lain

Pada pengantar artikel ini, telah di contohkan sebuah kasus untuk generate nomor invoice. Pada contoh ini, akan dijelaskan bagaimana implementasi package ini dari awal. Berdasarkan skenario ini, kita buat dahulu tabel invoices dengan data sederhana saja misalnya:

Setelah itu, kita buat model Invoice dengan menggunakan perintah dibawah ini:

php artisan make:model Invoice

Dengan perintah diatas, sekarang kita sudah memiliki sebuah model class baru pada directory app.

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Invoice extends Model
{
    //
}

Setup Model

Langkah selanjutnya adalah setup model yang akan digunakan, kita akan menggunakan model Invoice yang telah kita buat pada langkah sebelumnya.

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Alfa6661\AutoNumber\AutoNumberTrait;

class Invoice extends Model
{
    use AutoNumberTrait;

    /**
     * Return the autonumber configuration array for this model.
     *
     * @return array
     */
    public function getAutoNumberOptions()
    {
        return [
            'code' => [
                'format' => function () {
                    return date('Y.m.d') . '/INV/?';
                },
                'length' => 5
            ]
        ];
    }
}

Save Data

Format kode akan otomatis tergenerate ketika kita menyimpan data pada model berdasarkan pengaturan diatas.

$invoice = Invoice::create([
    'amount' => 5000,
]);

echo $order->code;
// 2019.11.27/INV/0001

Alfa Adhitya Member since December 18, 2019

Computer science education cannot make anybody an expert programmer any more than studying brushes and pigment can make somebody an expert painter – Eric S