📤 Dumper in Squehub

The Dumper system in Squehub helps you populate your database with test or fake data using clean PHP logic. It is useful for development, staging, demos, or local testing environments.

📁 Directory Structure

All Dumper classes must be created inside the database/dumper/ directory. Each Dumper must extend the base class App\Core\Dumper.

database/
└── dumper/
    └── UsersDumper.php

🧩 Example Dumper File

This example generates 10 users using the User model.

<?php

namespace Database\Dumper;

use App\Core\Dumper;             // ✅ Always required
use Project\Models\User;          // ✅ Only needed if interacting with the User model

class UsersDumper extends Dumper
{
    public function run()
    {
        for ($i = 1; $i <= 10; $i++) {
            User::create([
                'name' => "User $i",
                'username' => "user$i",
                'email' => "user$i@example.com",
                'password' => password_hash("password", PASSWORD_DEFAULT),
                'country' => 'USA',
                'status' => 'active',
            ]);
        }
    }
}

🚀 Running a Dumper

To run your Dumper class from the CLI:

$ php squehub dump:run UsersDumper

This will call the run() method and insert the data.

⚡ Generate One Automatically

You can use the CLI to scaffold a new Dumper file:

$ php squehub make:Dumper UsersDumper

This creates a file under database/dumper/ with the correct structure.

📘 Important Notes

• ✅ Always include use App\Core\Dumper; at the top — it powers the Dumper system.
• ✅ Only include use Project\Models\XYZ; when the dumper interacts with that model (e.g. User).
• 🧠 All Dumper classes must have a valid namespace — e.g. namespace Database\Dumper;.
• 🧪 Dumper files are for inserting fake/test data into real database tables.
• 📂 Keep logic simple: create one dumper per dataset type (users, products, orders, etc).

✅ Summary

• 📁 Dumper files live in database/dumper/.
• 🧱 They must extend App\Core\Dumper.
• 📦 Use model classes like use Project\Models\User; only when needed.
• 🔁 The run() method contains the data-insertion logic.
• 💻 Run with: php squehub dump:run YourDumperName.