fuelphp / fieldset
Form generation and building
Installs: 4 121
Dependents: 5
Suggesters: 1
Security: 0
Stars: 8
Watchers: 7
Forks: 5
Open Issues: 8
Requires
- php: >=5.4
- fuelphp/common: ~2.0
Requires (Dev)
- codeception/codeception: ~2.0.10
- codeception/mockery-module: dev-master
- fuelphp/validation: dev-master
Suggests
- fuelphp/validation: Allows forms to be validated
This package is auto-updated.
Last update: 2023-01-30 20:25:56 UTC
README
Form generation and building.
This package will replace the default Fieldset class provided by the FuelPHP v1.x core by the FuelPHP v2.0 fieldset package.
Install
Via Composer
$ composer require fuelphp/fieldset
Once the package reaches a suitable milestone a tagged release will be created.
Getting started
Forms are created by first creating a container object, a Form
or a Fieldset
. You can then add Inputs
to these containers.
<?php use Fuel\Fieldset\Form; use Fuel\Fieldset\Input; $form = new Form; $form[] = new Input\Text('name'); $form[] = new Input\Submit('submit', [], 'GO!'); //This will repopulate the form with any submitted data $form->repopulate(); //This will repopulate the form with the given data, the flag indicates wether to call `repopulate()` after or not $form->populate($myData, true);
InputElement types
The current InputElement
classes exist.
- Button
- Checkbox
- CheckboxGroup
- File
- Hidden
- Optgroup
- Option
- Password
- Radio
- RadioGroup
- Reset
- Select
- Submit
- Text
- Textarea
Grouped check boxes and radio buttons now have their own logic for repopulation and naming when used in groups, hence the ChecboxGroup
and RadioGroup
classes. Select
elements are comprised of Option
s and Optgroup
s.
For more info on check box/radio groups and selects please see here.
Showing the form
Unlike v1 fieldsets a totally separate class is used to create the html for the form. Whilst each InputElement
knows how to display itself in the most basic form the use of a Renderer
allows for more complex behaviour to be achieved.
This can include things such as generating the form in a table or as a list. By default BasicRender
will render the form in a table, much the same as the v1 fieldsets did.
In the future other basic renderers might be added to the package to support things like list based forms out of the box. Pull/merge requests are always welcome.
The render classes are all used in the same basic way:
<?php use Fuel\Fieldset\Render\BasicRender; $engine = new BasicRender(); $formHtml = $engine->render($form);
It is easily possible to create your own renderer if the default one does not suit your needs. For an example take a look at the BasicRender
code and additionally here. If you do make your own renderer for a UI kit or css framework then please consider submitting a pull request!
Included Renderers
Fieldset comes with a couple of basic renderes, a generic one that does not add any formatting or css and a Bootstrap3 based renderer that will build forms that are compatible with the Bootstrap CSS framework.