Cheers to Lewis and Excel Imports for Backpack!

Hey there!👋 Today, we're are not just diving into the code tutorial but taking a moment to appreciate @redsquirrelstudio (aka Lewis)....

Hey there!👋 Today, we're are not just diving into the code tutorial but taking a moment to appreciate @redsquirrelstudio (aka Lewis). He has dropped a beautiful "Import Operation" package for Backpack!

This package not only imports Excel but does so with a fancy GUI for column mapping.🚀

A Round of Applause for Lewis 🎉

Let's start this article by giving a big thanks to Lewis! You’ve made lives easier, and for that, we owe you a virtual high-five! 🙌 and a cup of coffee for your incredible contribution.

"With great package comes great responsibility."

Lewis, you’ve embraced that responsibility. You crafted a tool that works and does so with style. The GUI for column mapping? Pure genius. It’s like you knew exactly what we needed before we even knew it ourselves. Kudos!

Let's Get Down to Business: How to Use Import Operation 🚀

Installation

1. Install the Package:

composer require redsquirrelstudio/laravel-backpack-import-operation

2. Publish the config & run the migration:

php artisan vendor:publish --tag=laravel-backpack-import-operation-config
php artisan vendor:publish --tag=laravel-backpack-import-operation-migrations
php artisan migrate

Usage

1. Add ImportOperation to your CRUDController;

class ExampleCrudController extends CrudController
{
    use \Backpack\CRUD\app\Http\Controllers\Operations\ListOperation;    
    use \Backpack\CRUD\app\Http\Controllers\Operations\ShowOperation;
+   use \RedSquirrelStudio\LaravelBackpackImportOperation\ImportOperation;
    //...

2. Configure the columns inside setupImportOperation

protected function setupImportOperation()
{
    CRUD::addColumn([
        'name' => 'id',        
        'type' => 'number',
    ]);
    CRUD::addColumn([
        'name' => 'name',
        'type' => 'text',
    ]);
    CRUD::addColumn([
        'name' => 'gender',
        'type' => 'array',        
        'options' => [ 'male' => 'male', 'female' => 'female',]
    ]);
    CRUD::addColumn([
        'name' => 'dob',
        'label' => 'Birthday',
        'type' => 'date',
    ]);
    CRUD::addColumn([
        'name' => 'contacts',
        'type' => 'array',        
        'multiple' => true,
        'options' => 'any'
    ]);
}

Boom! You have a working operation to import spreadsheets. No new steps! Simple as other Backpack operations.🧑‍💻

Supported columns & customizations

Currently, it comes with Text, Number, Boolean, Date and Array columns. The good thing is you're free to add your custom columns.

You are also free to customize the import process by creating your Custom Import Classes.

This is cool😎 right?

Wait! There's more!... It offers a good set of prebuilt methods to make it fit in your needs:

• Validating your imports works similarly to validating a create or update method. This validates each row while importing and skips them if they don't pass.

CRUD::setValidation(CustomerRequest::class);

• Attach an Example File for your user to download. An example spreadsheet with data that you would expect them to upload.

$this->setExampleFileUrl('file-url');

• Sometimes, you may not want the user to map their columns, or need a fast import. In these cases, you can disable the user mapping step.

$this->disableUserMapping();

• After completing an import, the uploaded spreadsheet remains in storage by default. Delete the uploaded Excel after import to free up storage.

$this->deleteFileAfterImport();

• It's better to queue larger imports in the background. This way, the user won't have to wait for the import to happen when they press a button.

$this->queueImport();

To know more in detail, visit the package repo.

A Shoutout to the Backpack Community 🎒

Now, let's shift the spotlight to the Backpack community. We all know that behind every great software package is an even greater community. So, a big shoutout to the Backpack developers for rolling out awesome packages.

If you've got your secret sauce – your custom packages and hacks – we want to hear from you! Share your packages, and tell us your stories. It may get listed on the Backpack add-on page.

Your package stories make us do the happy dance! 💃🕺

How to create a Backpack add-ons?

• Checkout the documentation to create add-ons using the Addon Skeleton.
• For short tutorial, visit How to create a Backpack Add-On with a custom operation.

It's the express lane to becoming a Backpack maestro. The only limit is your imagination (and maybe a bit of coffee).

In Conclusion: Happy Backpacking! 🎒

So there you have it! Import Operation has landed. Lewis is our hero, and the Backpack community is the heartbeat of our coding adventures. Keep crafting, keep coding, and most importantly, keep smiling.😊

The Laravel journey is an adventure, and each package, each line of code, adds a little sparkle to the magic.

P.S. Lewis, keep up the good work!