README

BACA SAJA — File ini dikelola dari repositori utama dapodik-org/dapodik-laravel. Jangan edit langsung di sini.

Dapodik Eloquent Laravel

Model Eloquent Dapodik untuk Laravel.
Paket ini menyediakan model, migrasi, dan command untuk menerbitkan model Dapodik langsung ke aplikasi Laravel Anda.

Persyaratan

• PHP >=8.1
• Laravel 9 – 13
• Aplikasi Dapodik sudah terinstal dan database sudah tersedia

Instalasi

composer require dapodik-org/dapodik-laravel-eloquent

Dukungan database

Publikasi migrasi

php artisan vendor:publish --tag="dapodik-eloquent-migrations"
php artisan migrate

Publikasi konfigurasi

php artisan vendor:publish --tag="dapodik-eloquent-config"

Publikasi model

Publikasikan seluruh model ke aplikasi Anda:

php artisan dapodik:eloquent-publish

Untuk satu model saja, gunakan key model seperti agama:

php artisan dapodik:eloquent-publish agama

Perintah ini menyalin folder Models dari package ke app/Models/Dapodik dan mengubah namespace menjadi App\Models\Dapodik\....

Pembuatan database

Buat database Dapodik jika belum ada:

php artisan dapodik:eloquent-db-create

Perintah ini membaca konfigurasi koneksi dari DAPODIK_ELOQUENT_CONNECTION (atau koneksi default) dan membuat database bila belum tersedia.

Gunakan opsi --connection untuk koneksi tertentu:

php artisan dapodik:eloquent-db-create --connection=dapodik

Gunakan opsi --database untuk menentukan nama database:

php artisan dapodik:eloquent-db-create --database=dapodik_ref

Koneksi terpisah (split connection)

Saat split_connection diaktifkan, perintah ini otomatis membuat database/schema untuk setiap subdirektori model:

Konfigurasi

return [
    /*
     * Prefix tabel.
     */
    'prefix' => env('DAPODIK_ELOQUENT_PREFIX', 'dapodik'),

    /*
     * Suffix tabel.
     */
    'suffix' => env('DAPODIK_ELOQUENT_SUFFIX', null),

    /*
     * Nama koneksi database Laravel (dari config/database.php).
     * Biarkan null untuk menggunakan koneksi default.
     */
    'connection' => env('DAPODIK_ELOQUENT_CONNECTION', null),

    /*
     * Aktifkan split connection per subdirektori model.
     * Jika true, setiap subdirektori (ref, public, man_akses, dll.)
     * akan menggunakan koneksi terpisah: {connection}_{folder}.
     */
    'split_connection' => env('DAPODIK_ELOQUENT_SPLIT_CONNECTION', false),

    /*
     * Lewati drop tabel saat migrate:fresh.
     * Jika true, tabel dapodik tidak akan dihapus
     * saat php artisan migrate:fresh.
     */
    'skip_fresh' => env('DAPODIK_ELOQUENT_SKIP_FRESH', false),

    /*
     * Exclude tabel dari migration.
     * Lihat penjelasan di bawah untuk detailnya.
     */
    'exclude_tables' => [],
];

Pengecualian tabel

Gunakan exclude_tables untuk mencegah tabel tertentu dibuat saat migrasi awal. File migration create yang sesuai akan dihapus permanen dari filesystem sebelum migrasi dijalankan.

Catatan: Hanya berlaku untuk migration di folder database/migrations/dapodik/.

Pencocokan dilakukan terhadap:

• Nama file migration (tanpa timestamp): create_dapodik_sync_log_table
• Key tabel (snake_case) dari mapping internal: sync_log
• FQCN model class: \Dapodik\Laravel\Eloquent\Models\SyncLog::class

Regex diapit / dan dicocokkan terhadap ketiga target di atas.

'exclude_tables' => [
    'create_dapodik_sync_log_table',            // nama file migration
    'sync_primer',                              // key tabel
    \Dapodik\Laravel\Eloquent\Models\SyncLog::class,
    '/^create_dapodik_sync_.+$/',               // regex nama file
    '/^create_dapodik_vld_.+$/',                // regex nama file
    '/^log_/',                                  // regex key tabel diawali log_
    '/_log_/',                                  // regex key tabel mengandung _log_
],

Jika tabel sudah pernah di-exclude lalu ingin dikembalikan:

php artisan vendor:publish --tag=dapodik-eloquent-migrations --force

Skip fresh

Saat skip_fresh diaktifkan (true), tabel dapodik tidak akan dihapus saat php artisan migrate:fresh. Berguna menjaga data Dapodik tetap aman sementara tabel lain di-reset.

'skip_fresh' => env('DAPODIK_ELOQUENT_SKIP_FRESH', false),

Atur lewat .env:

DAPODIK_ELOQUENT_SKIP_FRESH=true

Koneksi terpisah (split connection)

Saat split_connection diaktifkan, setiap subdirektori model menggunakan koneksi database terpisah:

Suffix database (MySQL, MariaDB, SQL Server):

dapodik_ref, dapodik_public, ...

Search path (PostgreSQL):

ref, public, man_akses, ...

File database terpisah (SQLite):

database/dapodik_ref.sqlite, database/dapodik_public.sqlite, ...

Pengujian

composer test:eloquent

Kontribusi

Lihat CONTRIBUTING.md untuk detail.

Keamanan

Laporkan celah keamanan melalui kebijakan keamanan.

Kredit

• Dapodik Org
• Ade Reksi Susanto
• Semua kontributor

Lisensi

MIT License. Lihat LICENSE untuk detail.

Peringatan

Dengan menggunakan library ini, data individu setiap entitas Dapodik akan dikirim ke pihak ketiga sesuai konfigurasi yang Anda atur. Penyalahgunaan data diancam dengan UU Perlindungan Data Pribadi No 27 Tahun 2022 Pasal 67.

Pastikan Anda memahami dan menyetujui risiko sebelum menggunakan library ini.