Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codete/formgeneratorbundle
Symfony Bundle for dynamic Form generation
https://github.com/codete/formgeneratorbundle
bundle php symfony symfony-bundle
Last synced: about 8 hours ago
JSON representation
Symfony Bundle for dynamic Form generation
- Host: GitHub
- URL: https://github.com/codete/formgeneratorbundle
- Owner: codete
- License: mit
- Created: 2015-02-09T13:44:58.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2017-12-06T15:54:12.000Z (about 7 years ago)
- Last Synced: 2025-01-18T08:15:05.178Z (1 day ago)
- Topics: bundle, php, symfony, symfony-bundle
- Language: PHP
- Homepage:
- Size: 82 KB
- Stars: 34
- Watchers: 8
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
FormGeneratorBundle
===================
[](https://travis-ci.org/codete/FormGeneratorBundle)
[](https://insight.sensiolabs.com/projects/8893e0c9-ed68-498e-aa86-63320ac43a62)
We were extremely bored with writing/generating/keeping-up-to-date
our FormType classes so we wanted to automate the process and limit
required changes only to Entity/Document/Whatever class and get new
form out of the box - this is how FormGenerator was invented.
**You're looking at the documentation for version 2.0**
- [go to 1.x documentation](https://github.com/codete/FormGeneratorBundle/blob/1.3.0/README.md)
- [see UPGRADE.md for help with upgrading](https://github.com/codete/FormGeneratorBundle/blob/master/UPGRADE-2.0.md)
Basic Usages
------------
Consider a class
``` php
use Codete\FormGeneratorBundle\Annotations as Form;
// import Symfony form types so ::class will work
/**
* @Form\Form(
* personal = { "title", "name", "surname", "photo", "active" },
* work = { "salary" },
* admin = { "id" = { "type" = NumberType::class }, "surname" }
* )
*/
class Person
{
public $id;
/**
* @Form\Field(type=ChoiceType::class, choices = { "Mr." = "mr", "Ms." = "ms" })
*/
public $title;
/**
* @Form\Field(type=TextType::class)
*/
public $name;
/**
* @Form\Field(type=TextType::class)
*/
public $surname;
/**
* @Form\Field(type=FileType::class)
*/
public $photo;
/**
* @Form\Field(type=CheckboxType::class)
*/
public $active;
/**
* @Form\Field(type=MoneyType::class)
*/
public $salary;
}
```
Now instead of writing whole ``PersonFormType`` and populating
FormBuilder there we can use instead:
``` php
use Codete\FormGeneratorBundle\FormGenerator;
$generator = $this->get(FormGenerator::class);
$person = new Person();
$form = $generator->createFormBuilder($person)->getForm();
$form->handleRequest($request);
```
Voila! Form for editing all annotated properties is generated for us.
We could even omit ``type=".."`` in annotations if Symfony will be
able to guess the field's type for us.
Specifying Field Options
------------------------
By default everything you specify in `@Form\Field` (except for `type`) annotation
will be passed as an option to generated form type. To illustrate:
```php
/**
* @Form\Field(type=ChoiceType::class, choices = { "Mr." = "mr", "Ms." = "ms" }, "attr" = { "class" = "foo" })
*/
public $title;
```
is equivalent to:
```php
$fb->add('title', ChoiceType::class, [
'choices' => [ 'Mr.' => 'mr', 'Ms.' => 'ms' ],
'attr' => [ 'class' => 'foo' ],
]);
```
This approach has few advantages like saving you a bunch of keystrokes each time you
are specifying options, but there are downsides too. First, if you have any custom
option for one of your modifiers you forget to `unset`, Symfony will be unhappy and
will let you know by throwing an exception. Another downside is that we have reserved
`type` property and it's needed as an option for the repeated type. If you ever find
yourself in one of described cases, or you just prefer to be explicit, you can put
all Symfony fields' options into an `options` property:
```php
/**
* @Form\Field(
* type=ChoiceType::class,
* options={ "choices" = { "Mr." = "mr", "Ms." = "ms" }, "attr" = { "class" = "foo" } }
* )
*/
public $title;
```
When Form Generator creates a form field and finds `options` property, it will pass
them as that field's options to the `FormBuilder`. Effectively this allows you to
separate field's options from options for your configuration modifiers which can be
a gain on its own.
Adding fields not mapped to a property
--------------------------------------
Sometimes you may need to add a field that will not be mapped to a property. An example
of such use case is adding buttons to the form:
```php
/**
* The first value in Field annotation specifies field's name.
*
* @Form\Field("reset", type=ResetType::class)
* @Form\Field("submit", type=SubmitType::class, "label"="Save")
*/
class Person
```
All fields added on the class level come last in the generated form, unless a form view
(described below) specifies otherwise. Contrary to other class-level settings, `@Field`s
will not be inherited by child classes.
Form Views
----------
In the example we have defined additional form views in ``@Form\Form``
annotation so we can add another argument to ``createFormBuilder``
``` php
$form = $generator->createFormBuilder($person, 'personal')->getForm();
```
And we will get Form with properties specified in annotation. We can
also add/override fields and their properties like this:
``` php
/**
* @Form\Form(
* work = { "salary" = { "attr" = { "class" = "foo" } } }
* )
*/
class Person
```
But if you need something more sophisticated than Annotations we
have prepared few possibilities that can be either added manually
or by tagging your services. For each of them FormGenerator allows
you to pass any additional informations you want in optional
``$context`` argument. Both ways allows you to specify `priority`
which defines order of execution (default is `0`, if two or more
services have same priority then first added is executed first).
**If you have enabled [Service autoconfiguration](http://symfony.com/blog/new-in-symfony-3-3-service-autoconfiguration)
the bundle will automatically tag services for you.**
FormViewProvider
----------------
These are used to provide fields list and/or basic configuration
for Forms and are doing exactly same thing as ``@Form\Form``
annotation.
Tag for service: ``form_generator.view_provider``
FormConfigurationModifier
-------------------------
These can modify any form configuration provided by class
itself or FormViewProviders. Feel free to remove or add more
stuff to your Form or tweak existing configuration
Tag for service: ``form_generator.configuration_modifier``
``` php
class InactivePersonModifier implements FormConfigurationModifierInterface
{
public function modify($model, $configuration, $context)
{
unset($configuration['salary']);
return $configuration;
}
public function supports($model, $configuration, $context)
{
return $model instanceof Person && $model->active === false;
}
}
```
FormFieldResolver
-----------------
These are responsible for creating actual field in Form and can
be used for instance to attach Transformers to your fields.
Tag for service: ``form_generator.field_resolver``
``` php
class PersonSalaryResolver implements FormFieldResolverInterface
{
public function getFormField(FormBuilderInterface $fb, $field, $type, $options, $context)
{
$transformer = new /* ... */;
return $fb->create($field, $type, $options)
->addViewTransformer($transformer);
}
public function supports($model, $field, $type, $options, $context)
{
return $model instanceof Person && $field === 'salary';
}
}
```
Embedded Forms
--------------
If you need embedded forms we got you covered:
``` php
/**
* @Form\Embed(class="Codete\FormGeneratorBundle\Tests\Model\Person")
*/
public $person;
```
Such sub-form will contain all annotated properties from given model.
To specify a view for the generated embedded form just specify it in
the configuration:
``` php
/**
* @Form\Embed(
* class="Codete\FormGeneratorBundle\Tests\Model\Person",
* view="work"
* )
*/
public $employee;
```