appoly/smart-schema

Form helper for Laravel

Laravel: Smartfields & form helper

Tired of repeating yourself? This package centralises everything to do with fields., _(*1)

Navigation - Introduction - Field Types - Virtual Fields - Validation Rules - Model Attributes - Forms - Code Generation, _(*2)

Quick Usage

Add to composer.json:, _(*3)

"appoly/smart-schema": "^0.6.3",

Introduction

Instead of having to create a migration, a request, form views and set up fillable fields, we can instead create a smart migration which handles it all., _(*4)

Example migration:, _(*5)

SmartSchema::create('sites', function ($table) {
    $table->increments("id");

    $table->integer("name");

    $table->text("name")
        ->nullable()
        ->required()
        ->fillable()
        ->max(5)
        ->forms([
            'type' => 'text',
            'label' => 'Site name'
        ]);

    $table->timestamps();
});

Options for fields

Field Types

Standard field types area available., _(*6)

$table->text("name")
$table->integer("user_id")
$table->float("latitude")

etc..., _(*7)

Virtual Fields

In some cases, we may want fields in a form that don't correspond directy to our database tables., _(*8)

We can then use:, _(*9)

$table->virtual("slot")->forms(...

Validation Rules

These can be chained to a field creation in your migration., _(*10)

Example:, _(*11)

$table->text("email")->required()->email();

Available rules:, _(*12)

->unique()
->required()
->email()
->max( val )
->min( val )

Custom validation rules can be added with:, _(*13)

->addRule( rule )

When storing the object in your controller, the validation helper should be called with the object type:, _(*14)

public function store(Request $request) {
    SchemaHelper::validate($request, 'sites');

    // Process the request
    // ...
}

Model attributes

fillable(), _(*15)

Casts:, _(*16)

->array()
->datetime()

Model must have the SmartField trait to use fillable() or any of the attribute casts., _(*17)

class User extends Model
{
    use SmartField;
}

Forms

The form helper will generate (currently Bootstrap 4) forms based on the field data., _(*18)

In migration, use ->forms([... to show a field in the auto-generated forms:, _(*19)

->forms([
    'type' => 'text',
    'label' => 'Site name'
])

To render a basic form:, _(*20)

{!! \Appoly\SmartSchema\SchemaHelper::form('sites', route('sites.store')) !!}

Multiple choice form fields such as selects and radio buttons will need a set of options., _(*21)

In the case of the following field:, _(*22)

$table->id("role")
        ->forms([
            'type' => 'select', // or 'type' => 'radio'
            'label' => 'Role'
        ]);

Options can be passed like so:, _(*23)

{!! \Appoly\SmartSchema\SchemaHelper::form('sites', route('sites.store'), [
    'select_options' => [
        'role_id' => ['User', 'Admin']
    ]
]) !!}

Or with keys, _(*24)

{!! \Appoly\SmartSchema\SchemaHelper::form('sites', route('sites.store'), [
    'select_options' => [
        'role_id' => [
            10001 => 'User', 
            20001 => 'Admin'
        ]
    ]
]) !!}

Code Generation

This package includes a console command which will set up a boilerplate controller and view code., _(*25)

php artisan crud:generate {resource_name_singular}, _(*26)

For example:, _(*27)

php artisan crud:generate client, _(*28)