README

Adds an interface for soufiene-slimi/laravel-form-template to your Backpack CRUDs, so that the admin can:

save entries forms as a template;
apply those template while creating new ones;

soufiene-slimi/laravel-form-template allows you to save some form templates to apply them whenever you want. the utility is to avoid filling some inputs again and again, that most of the time have the same values, or maybe to apply some template based on the user choice.

When used, this operation will show another button beside the create button in the listing view. On click, that button opens another page, which will allow an admin to create a template for that entry:

Installation

Step 1. Require the package:

composer require soufiene-slimi/template-operation

This will automatically install soufiene-slimi/laravel-form-template too, if it's not already installed.

Step 2. Migrate the soufiene-slimi/laravel-form-template table:

php artisan migrate

Step 3. In your CrudController, use the operation trait:

<?php

namespace App\Http\Controllers\Admin;

use Backpack\CRUD\app\Http\Controllers\CrudController;

class InvoiceCrudController extends CrudController
{
    use \SoufieneSlimi\TemplateOperation\TemplateOperation;

For complex usage, head on over to soufiene-slimi/laravel-form-template to see the full documentation and extra configuration options.

Usage

After installing the operation, you need to define the template fields and validation (if necessary) like in the create operation.

protected function setupTemplateOperation()
    {
        $this->crud->setValidation(InvoiceTemplateRequest::class);

        $this->crud->setOperationSetting('excludedInputs', ['paid']);

        CRUD::field('title')->type('custom_html')->value('<h1>FXXXX-XXXXXX</h1>')->size(8);
        CRUD::field('type')->default(3)->size(4);
        CRUD::field('hr')->type('custom_html')->value('<hr>');
        CRUD::field('client')->size(6);
        CRUD::field('items')->type('repeatable')->fields([
            [
                'name' => 'product',
                'label' => 'Product',
                'type' => 'select2_from_array',
                'options' => Product::get(['id', 'name'])->pluck('name', 'id')->toArray(),
                'wrapperAttributes' => ['class' => 'form-group col-md-6'],
            ],
            [
                'name' => 'quantity',
                'label' => 'Quantity',
                'type' => 'number',
                'wrapperAttributes' => ['class' => 'form-group col-md-3'],
                'attributes' => ['step' => 'any'],
            ],
            [
                'name' => 'price',
                'label' => 'Price',
                'type' => 'number',
                'wrapperAttributes' => ['class' => 'form-group col-md-3'],
                'attributes' => ['step' => 'any'],
            ],
        ]);
        CRUD::field('total')
            ->label('Total ('.config('settings.currency').')')
            ->type('number')
            ->size(5)
            ->attributes(['readonly' => 'true']);
        CRUD::field('paid')->type('number')->attributes(['step' => 'any'])->size(5);
        CRUD::field('wallet')->default(config('settings.default_wallet'))->size(2);
    }

If you need to customize some settings, you need to add the operation settings in the config\backpack\crud.php file.

'operations' => [
    /*
    * Template Operation
    */
    'template' => [
        // The cards color
        // Available colors: bg-blue, bg-green, bg-purple, bg-orange, bg-red
        'cardsClass' => 'bg-orange',
        // How many cards per row
        'cardsPerRow' => 3,
        // The card icon
        'cardIcon' => '<i class="las la-pen-alt"></i>',
        // Excluded columns
        'excludedInputs' => ['status_id']
    ],
]

Note that those are global operation settings, means that those settings will be applied to all template operations, but you steel can define or override those in your EntityCrudController by using $this->crud->setOperationSetting('key', value); inside the setupTemplateOperation function.

Screenshots

Template listing

Add new template

Change log

Please see the CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details and a todolist.

Security

If you discover any security related issues, please email soufiene.slimi@mail.com instead of using the issue tracker.

Credits

License

MIT. Please see the license file for more information.

soufiene-slimi / template-operation

Maintainers

Details