ilyasavich/form-builder

The form builder service for laravel app

Laravel Form Builder

The form builder service for Laravel, _(*1)

Installation

Require

composer require ilyasavich/form-builder

Register Provider and Facade

in app.php config

'providers' => [
    // ...
    Savich\FormBuilder\FormServiceProvider::class,
],

Publish config

php artisan vendor:publish --provider="Savich\FormBuilder\FormServiceProvider" --tag=config

Usage

To create new form first of all extending base Form class and overwrite method make. This method implements form building logic, _(*2)

use Savich\FormBuilder\Form;
use Savich\FormBuilder\FormBuilder;

class UserForm extends Form
{
    protected function make(FormBuilder $builder): FormBuilder
    {
    }
}

Create inputs

The package provide to create all available html inputs. To add new input in your form class you need call add method of builder instance. It signature, _(*3)

public function add(string $inputNamespace, string $name, $value = null, array $options = []) : Input

To create simple input write ..., _(*4)

use Savich\FormBuilder\Form;
use Savich\FormBuilder\FormBuilder;
use Savich\FormBuilder\Inputs\EmailInput;

class UserForm extends Form
{
    protected function make(FormBuilder $builder): FormBuilder
    {
        $builder->add(EmailInput::class, 'email');
    }
}

Customization

Attributes

Here are several methods to customize input, _(*5)

// you can set input attributes in different ways
// also you can specify default input value

$value = 'Hello World!';
$attributes = ['class' => 'form-control'];
$builder->add(TextInput::class, 'input_name', $value)->attributes($attributes);
$builder->add(TextInput::class, 'input_name', $value, $attributes);

Labels

$builder->add(TextInput::class, 'input_name')->label('My Label');

Group customization

By default inputs will generating in such format, _(*6)

$builder->add(TextInput::class, 'input_name');

// generated view




    

If you don't need to wrap input by group, _(*7)

$builder->add(TextInput::class, 'input_name')->withoutGroup();

// generated view

<input type="text" name="input_name">

You can customize group attributes, _(*8)

$builder->add(TextInput::class, 'input_name')->groupAttributes(['class' => 'my-class', 'inputID']);

// generated view




    

Overwrite views

If you need specific input generating you can overwrite default view by your custom, _(*9)

$builder->add(TextInput::class, 'input_name')->view('path.to.view');

In case where you need to overwrite view without group you can ..., _(*10)

//this will overwrite code inside form-group div
$builder->add(TextInput::class, 'input_name')->internalView('path.to.view');

When you need to overwrite only group you can ... In view you have $input object that is an instance of your input class., _(*11)

$builder->add(TextInput::class, 'input_name')->view('path.to.view');

// in resources.views.path.to.view
// in withoutGroupView there path to internal view, you can specify custom or there will be default


generateGroupAttributes() !!}>
    // write custom stuff ...
    @include($input->withoutGroupView)

Available input properties

The you can find list of available properties of $input object, _(*12)

Create simple form

For example you need to create simple login form with at least two inputs. Ok, it will something like that, _(*13)

use Savich\FormBuilder\Form;
use Savich\FormBuilder\FormBuilder;

class LoginForm extends Form
{
    protected function make(FormBuilder $builder)
    {
        $builder->email('email')->label('Email');
        $builder->password('password')->label('Password');

        $builder->submit('Save');
    }
}

After that you need to add this form in controller action, _(*14)

class LoginController extends Controller
{
    public function showLoginForm(LoginForm $form)
    {
        $formHtml = $form->create();

        return view('login')->with('form', $formHtml);
    }
}

And, finally, render form in view file, _(*15)

in resources/views/login.blade.php

{!! $form !!}

Lets create action for submitting login form. In our controller, _(*16)

class LoginController extends Controller
{
    // ...

    public function login(LoginForm $form)
    {
        $form->request(); // access to request

        // login logic
    }
}