PHPackages pta/formbuilder - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. pta/formbuilder ActiveLibrary[Utility & Helpers](/categories/utility) pta/formbuilder =============== Automatically generate form definitions from SQL Schema 1.0.4(9y ago)05.9kPHPPHP >=5.4.0 Since Jul 21Pushed 8y ago1 watchersCompare [ Source](https://github.com/drparham/formbuilder)[ Packagist](https://packagist.org/packages/pta/formbuilder)[ RSS](/packages/pta-formbuilder/feed)WikiDiscussions master Synced 2w ago READMEChangelogDependencies (1)Versions (36)Used By (0) FormBuilder =========== [](#formbuilder) The Form Builder will dynamically generate a 'create' form, and an 'update' form for any given model. The Form Builder will pull down the model's table schema, and map form fields to schema types to determine how to generate a form. Installation ============ [](#installation) To install, run `composer require pta/formbuilder` on your command line. Or you can add the below to your `composer.json` file manually: ``` "require": { "pta/formbuilder": "0.2.*", } ``` Service Provider ---------------- [](#service-provider) You will need to add `Pta\Formbuilder\Providers\FormBuilderServiceProvider::class,` to your provider array in `app.php` config. Facade ------ [](#facade) You will need to add `'FormBuilder'=> Pta\FormBuilder\Facades\FormBuilder::class,` to your Facades array in `app.php` config if you want to use the Facade in your views. Usage ===== [](#usage) To use FormBuilder, extend your model with `Pta\Formbuilder\Lib\ModelSchemaBuilder`. In your view where you want to display a Form for your Model, type: `{!! FormBuilder::buildForm('Namespace\To\Models\ModelName', 'Method', 'Named Route', 'FormType', ID, 'translation namespace') !!}` 'ID' and 'translation namespace' can be `NULL` values. Example: This form will create a new User `{!! FormBuilder::buildForm('Pta\Formbuilder\Models\User', 'POST', 'User.Create', 'create') !!}` This form will update User with an ID of 1 `{!! FormBuilder::buildForm('Pta\Formbuilder\Models\User', 'POST', 'User.Update', 'update', 1) !!}` The forms are built using a series of partial views for each input type, and depending on if it's a 'create' or 'update' form. The form's HTML is based off [Bootstrap 3](https://getbootstrap.com/docs/3.3/) and is completely customizable. Publish the views and customize them however you want. Using Translations ------------------ [](#using-translations) FormBuilder allows you to pass a namespace path for using a translation file for form labels. For example, I could have a translation namespace configured for a User Model below: `{!! FormBuilder::buildForm('Pta\Formbuilder\Models\User', 'POST', 'User.Update', 'update', 1, 'Pta\Formbuilder\User::') !!}` If we wanted to use a Translation file with a 'create' form, we would need to adjust the create example above as follows: `{!! FormBuilder::buildForm('Pta\Formbuilder\Models\User', 'POST', 'User.Create', 'create', null, 'Pta\Formbuilder\User::') !!}` We will have to pass a NULL value for the ID value. Publish Views ------------- [](#publish-views) `php artisan vendor:publish --provider="Pta\Formbuilder\Providers\FormBuilderServiceProvider" --tag="views"` Overloading Default Behavior ---------------------------- [](#overloading-default-behavior) In the config file, we have several areas where we can adjust default behaviors. ### Publish Config [](#publish-config) `php artisan vendor:publish --provider="Pta\Formbuilder\Providers\FormBuilderServiceProvider" --tag="config"` ### Defining NameSpace to your models [](#defining-namespace-to-your-models) The FormBuilder config allows you to define the NameSpace for your models: ``` 'entity' => [ 'namespace' => 'App\\', ], ``` After you define your model's namespace in the config you can do the following: `{!! FormBuilder::buildForm('User', 'POST', 'User.Create', 'create', null, 'Pta\Formbuilder\User::') !!}` If you have your models in multiple places (for instance, multiple packages using FormBuilder), you can still define a fully qualified namespaced class name for the model you want to build a form off of. By default it will check to see if the model exists as passed in. If formbuilder can't find it, it will try using the NameSpace path + model name you passed in to find the model. ### Default Labels [](#default-labels) In the config file there is an array of labels. This array is `column name => Label`. Edit the config file to make adjustments or add more labels. You can adjust this list on a per-model basis by declaring a `protected $formLabels` array in your model. ``` /* |-------------------------------------------------------------------------- | Default Field Labels |-------------------------------------------------------------------------- | | This option allows you to define what labels to use as defaults based on | standard column name formats. Add or modify to fit your implementation. | To override these values on a per model basis, create an array in | your Model with the name of $formLabels | */ 'labels' => [ 'email' => 'Email Address', 'email2' => 'Secondary Email Address', 'first_name' => 'First Name', 'last_name' => 'Last Name', 'username' => 'Username', 'password' => 'Password', 'middle_initial' => 'Middle Initial', 'gender' => 'Gender', 'address1' => 'Address', 'address' => 'Address', 'address2' => 'Address Continued', 'city' => 'City', 'state' => 'State', 'zip' => 'Zip Code', 'country' => 'Country', 'phone' => 'Phone Number', 'fax' => 'Fax Number', 'dob' => 'Date of Birth', 'tos' => 'Terms of Service', ], ``` ### Default Skipped form fields [](#default-skipped-form-fields) It's likely you don't want every column to show up on your form. The config file has a 'fields' array that consists of column names we don't want to create a form element for. ``` /* |-------------------------------------------------------------------------- | Default Fields to skip populating on form |-------------------------------------------------------------------------- | | This option allows you to define what fields/columns to ignore when | building out a form. To override these values on a per model basis, | create an array in your Model with the name of $skipFields | */ 'fields' => [ 'created_at', 'deleted_at', 'active', 'updated_at', 'permissions', 'last_login', 'password_date', 'remember_token', 'customer_id', 'all', ], ``` Add or delete items from this list to change form behavior. You can also declare `$skipFields` in your model, and assign an array of columns to skip on a per model basis. ### Default Form Input Mapping [](#default-form-input-mapping) In the config we also have an array that maps column types, to input types. ``` /* |-------------------------------------------------------------------------- | Default mapping of column types to form types |-------------------------------------------------------------------------- | | This option allows you to define the mapping of inputs field types from | the schema to form input types. Example: Varchar is a string, so defaults | to Input etc. To override these values on a per model basis, create | an array in your Model with the name of $formInputs | */ 'inputs' => [ 'hidden' => 'Hidden', 'varchar' => 'Input', 'int' => 'Input', 'date' => 'DateInput', 'tinyint' => 'CheckBox', 'text' => 'Text', 'smallint' => 'CheckBox' ], ``` Adjust this array or add new fields to it to fit your implementation. Further Customization --------------------- [](#further-customization) If you have a database field that needs some more customized mapping, you can easily overload the default field type by declaring a a public method with the name of the column with `FB_` proceeding it. This will let FormBuilder know it's a FB Method. An example of this would be a drop down. If for instance you have a relationship with another model, like a one-to-one, you would want to provide a 'select' field for an 'Int' database field. Typically the 'Int' type will default to a regular Input field. ``` public function FB_school_id() { return new SelectField(new School, 'id', 'name'); } ``` The first parameter is a new instance of the model you want to use to populate the drop down. The second parameter is the column name you want to use as the 'ID' of `` tag. The third parameter is the name you want to use to populate the name of the `{{ $name }}` tag. ### Passing a Closure [](#passing-a-closure) You can also pass a closure to a SelectField if you want to pass customized data to the select field, and not all of the data in "school" for instance above. ``` public function FB_department_id() { $department = new Department; return new SelectField($department, 'name', function() use ($department) { if(is_subclass_of($department, 'Illuminate\Database\Eloquent\Model')){ return $department->where('active',1)->get(array('id','name')); } return false; }); } ``` You can also pass a collection to the SelectField if you want to define static options for a select field. ``` public function FB_active() { $collection = \collect([(object)['name' => 'No', 'id' => "0"],(object)['name'=>'Yes', 'id' => "1"]]); return new SelectField(null, 'name', function() use ($collection) { return $collection; }); } ``` ### Adding form fields [](#adding-form-fields) To add form fields that are not part of your table schema, add the following protected array: ``` protected $addFields = [ 'form_input_id', ]; ``` In addition to adding this array, you will need a method on your model of `FB_form_input_id()` to match the new form fields you're adding. If you add a field and don't provide a method for the field, FormBuilder will throw an error. This should allow you to customize the form layout as much as you want, or simply use the default values. ### Health Score 32 — LowBetter than 69% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity17 Limited adoption so far Community9 Small or concentrated contributor base Maturity70 Established project with proven stability Bus Factor1 Top contributor holds 98.7% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~20 days Recently: every ~2 days Total 35 Last Release 3300d ago Major Versions 0.2.10 → 1.0.02017-06-02 ### Community Maintainers ![](https://www.gravatar.com/avatar/57b3fd4aca243a66f2762ca0f4c5c0aa47aa97178e8f04e0e983c43e21c77642?d=identicon)[drparham](/maintainers/drparham) --- Top Contributors [![drparham](https://avatars.githubusercontent.com/u/2704700?v=4)](https://github.com/drparham "drparham (78 commits)")[![cbeninati](https://avatars.githubusercontent.com/u/1027918?v=4)](https://github.com/cbeninati "cbeninati (1 commits)") ### Embed Badge ![Health badge](/badges/pta-formbuilder/health.svg) ``` [![Health](https://phpackages.com/badges/pta-formbuilder/health.svg)](https://phpackages.com/packages/pta-formbuilder) ``` ### Alternatives [devrabiul/laravel-seo-manager Laravel SEO Manager is an SEO tool that improves SEO by adding recommended meta tags. 396.1k](/packages/devrabiul-laravel-seo-manager) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)