The new form framework

The new form framework Bernhard Schussek

What is different in the new form framework?

symfony 1.x User sfForm Controller Domain Model

symfony 1.x User sfForm Business Logic Controller Domain Model

symfony 1.x User sfForm Business Logic Controller Domain Model unit testable!!

symfony 1.x User function configure() { unset($this['foo']); sfFormDoctrine / sfFormPropel unset($this['bar']); unset($this['moo']); unset($this['comeon!']); ... Domain Model

New architecture

Simplicity and Reusability

Embrace your domain model

Symfony 2 User Form Domain Model

Symfony 2 User Presentation Form Domain Model Business Logic designed by you™

Business Logic class Customer { public $name = 'Default'; public getGender(); public setGender($gender); }

Business Logic Presentation class Customer Form { TextField public $name = 'Default'; public getGender(); ChoiceField public setGender($gender); }

$form = new Form('customer', $customer, ...); $form->add(new TextField('name')); $form->add(new ChoiceField('gender', array( 'choices' => array('male', 'female'), )));

$form = new Form('customer', $customer, ...); ... if (isset($_POST['customer'])) { $form->bind($_POST['customer']); }

Business Logic Presentation class Customer Form { to-one relations FieldGroup public $address; }

$group = new FieldGroup('address'); $group->add(...); $group->add(...); $group->add(...); $form->add($group);

Business Logic Presentation class Customer Form { CollectionField to-many relations FieldGroup public $emails; FieldGroup }

$group = new FieldGroup('emails'); $group->add(...); $group->add(...); $form->add(new CollectionField($group));

Default Localized TextField NumberField TimeField TextareaField IntegerField DateTimeField CheckboxField PercentField TimezoneField ChoiceField MoneyField RepeatedField PasswordField DateField CollectionField HiddenField BirthdayField FieldGroup Special

● Field groups — light-weight subforms — compose other fields or field groups ? DateField ChoiceField ChoiceField CheckboxField CheckboxField

Form Rendering

<?php echo $form->renderFormTag('url') ?> <?php echo $form->renderErrors() ?> <?php echo $form->render() ?> <input type="submit" value="Submit" /> </form>

<label for="<?php echo $form['name']->getId() ?>"> Enter a name </label> <?php echo $form['name']->renderErrors() ?> <?php echo $form['name']->render() ?>

<?php echo $form['date']['day']->render() ?> <?php echo $form['date']['month']->render() ?> <?php echo $form['date']['year']->render() ?>

Validation

symfony 1.x sfForm sfValidator Controller Domain Model Doctrine_Validator

symfony 1.x sfForm sfValidator Controller Duplicate validation logic Domain Model Doctrine_Validator Failed validation leads to 505 errors

Symfony 2 Form Domain Model

Symfony 2 Form Validator Domain Model

Symfony 2 Form Validator Domain Model Validation Metadata "how shall the domain model be validated?"

Customer: properties: name: - MinLength: 6 birthday: - Date: ~ gender: - Choice: [male, female]

<class name="Customer"> <property name="name"> <constraint name="MinLength">6</constraint> </property> <property name="birthday"> <constraint name="Date" /> </property> <property name="gender"> <constraint name="Choice"> <value>male</value> <value>female</value> </constraint> </property> </class>

class Customer { /** @Validation({ @MinLength(6) }) */ public $name; /** @Validation({ @Choice({"male", "female"}) }) */ public function getGender(); /** @Validation({ @Valid }) */ public $gender; }

Type Check String Other AssertTrue AssertType MinLength Min AssertFalse Date MaxLength Max Blank DateTime Regex Choice NotBlank Time Url Valid Null Email Collection NotNull File

● Constraints can be put on — Classes — Properties — Methods with a "get" or "is" prefix

$validator = $container->getService('validator'); $validator->validate($customer);

Independent from Symfony 2 Zend Doctrine 2 Propel

How does all this fit into the form framework?

$form = new Form('customer', $customer, $this->container->getService('validator'));

$form->bind($_POST['customer']); if ($form->isValid()) { // do something with $customer }

● The validation is launched automatically upon submission

Common Questions

Q: What if my form does not translate 1:1 to a domain model?

A: Then the domain model doesn't exist yet ;-)

● Use Case — Extend our form for a checkbox to accept terms and conditions — Should not be stored as field in the Customer class

class Registration { /** @Validation({ @Valid }) */ public $customer; /** * @Validation({ * @AssertTrue(message="Please accept") * }) */ public $termsAccepted = false; public function process() { // save $customer, send emails etc. } }

$form->add(new CheckboxField('termsAccepted')); $group = new FieldGroup('customer'); $group->add(new TextField('name')); ... $form->add($group);

if ($form->isValid()) { $registration->process(); }

● The Registration class — can be reused (XML requests, …) — can be unit tested

Q: What if I don't want to validate all attributes of an object?

A: Use Constraint groups

● Use Case — Administrators should be able to create Customers with empty names — Normal users not

class Customer { /** * @Validation({ * @NotBlank(groups="User") * }) */ public $name; ... }

$validator->validate($customer, 'User');

$form->setValidationGroups('User'); $form->bind($_POST('customer')); if ($form->isValid()) { ... }

● Constraint groups can be sequenced — first validate group "Fast" — then, if "Fast" was valid, validate group "Slow"

Questions?

http://www.symfony-project.org	558
http://www.symfony.es	458
http://www.symfonylab.com	243
http://romain.cambien.net	216
http://symfony.com	107
http://swik.net	77
http://www.symfony.gr.jp	74
http://moooori-blog.undo.jp	13
http://rcambien.tumblr.com	7
http://static.slidesharecdn.com	6
http://www.phpframeworks.com	5
http://translate.googleusercontent.com	5
http://www.prestataire-symfony.com	4
http://symfony.lab216.com	3
http://rimzy.net	3
http://webcache.googleusercontent.com	3
http://www.slideshare.net	2
http://feeds.feedburner.com	2
http://coderwall.com	2
https://klti.de	1
http://127.0.0.1:8795	1
http://www.sfexception.com	1

The new form framework

by Bernhard Schussek on Jun 23, 2010

Accessibility

Categories

Tags

Upload Details

Usage Rights

22 Embeds 1,791

Statistics

The new form framework — Presentation Transcript