3 Steps to Symfony2 Form Mastery

3 Steps
3 Steps
to Symfony2 Form Mastery
to Symfony2 Form Mastery
Bernhard
Bernhard Schussek aka @webmozart
Schussek aka @webmozart
SymfonyDay Portugal
SymfonyDay Portugal
March 8th, 2014
March 8th, 2014

View Slide

Bernhard Schussek @webmozart 2/101
Bernhard Schussek
Not:
Bernard
Bernhart
Bernardt
Bernharth
Also Wrong:
Schusseck
Schusek
Shusseck
Scussek
Shcusek Schuseck
Shusek
Schuhsek
Shuhseck
Shushek
Shuseck
Shusec
Shushek
Shushek
Shushec
Sussek
Shussec
Schußeck
Scusek
Shußec
Schuhsec
Shußec
Schushek
Schusheck

View Slide

Bernard
@webmozart
"that Forms guy"

View Slide

http://commons.wikimedia.org/wiki/File%3AAustralia-New_Guinea_(orthographic_projection).svg

View Slide

http://upload.wikimedia.org/wikipedia/commons/b/b3/Blank_map_of_Europe.svg

View Slide

Austria

View Slide

flag of Austria not the flag of Austria
http://en.wikipedia.org/wiki/File:Flag_of_Austria.svg http://en.wikipedia.org/wiki/File:Zeichen_267.svg

View Slide


View Slide

Symfony Form Guru
in 30 minutes

View Slide

3 Simple Steps

View Slide

Outline
●
Today's Example
●
Step 1: Understand Data Formats
●
Step 2: Become Friends with Data Mappers
●
Step 3: Get Ready for the Event

View Slide

Example

View Slide

Today's Example

View Slide

Form
Form
Form
Form
Form
Form
Form
Symfony's Perspective
Form Form Form
Form
Form
Form
Form

View Slide

Form Tree
Form
Form
Form
Form
Form
Form
Form
$factory = Forms::createFormFactory();
$form = $factory->createForm(...);

View Slide

Forms Have Names
month
day
year
employee
name
salary
birthDate
$builder = $factory->createNamedBuilder('employee');
$builder->add('name');
$builder->add('salary');
$builder->add('birthDate');
$form = $builder->createForm();
1

View Slide

Forms Have Names
month
day
year
employee
name
salary
birthDate
$form->get('birthDate');
$form->get('birthDate')->get('year');
1

View Slide

Forms Have Types
month
[choice]
day
[choice]
year
[choice]
employee
[form]
name
[text]
salary
[money]
birthDate
[birthdate]
$builder = $factory->createNamedBuilder('employee', 'form');
$builder->add('name', 'text');
$builder->add('salary', 'money');
$builder->add('birthDate', 'birthdate');
$form = $builder->createForm();
2

View Slide

Forms Have Data
employee
[form]
data
name
[text]
data
salary
[money]
data
birthDate
[birthdate]
data
day
[choice]
data
month
[choice]
data
year
[choice]
data
3

View Slide

Form Lifecycle
New Prepopulated
Bound
setData($data)
submit($data)
submit($data) / setData(null)
implicitly called

View Slide

Prepopulation
employee
[form]
data
name
[text]
data
salary
[money]
data
birthDate
[birthdate]
data
year
[choice]
data
month
[choice]
data
day
[choice]
data
$employee = new Employee();
$employee->name = 'Jane';
$employee->salary = 110000.0;
$employee->birthDate = new DateTime('1941-09-09');
$form->setData($employee);

View Slide

Prepopulation
employee
[form]
Employee Object
name
[text]
salary
[money]
birthDate
[birthdate]
year
[choice]
month
[choice]
day
[choice]
data
data
data
"Jane"
110000.0
DateTime Object
data
data
data
1941
9
9

View Slide

employee
[form]
object (Employee)
name
[text]
"Jane"
salary
[money]
110000.0
birthDate
[birthdate]
object (DateTime)
day
[choice]
1941
month
[choice]
9
year
[choice]
9
$form->handleRequest($request);

View Slide

?
employee
[form]
Employee Object
name
[text]
"Jane"
salary
[money]
110000.0
birthDate
[birthdate]
DateTime Object
year
[choice]
1941
month
[choice]
9
day
[choice]
9
"1962"
"95000.00" "5"
"26"
"John"

View Slide

http://www.flickr.com/photos/yourdon/2573762303/
Step 1:
Understand Data Formats

View Slide

Formats who?

View Slide

Data Formats
Form
model
data
view
data

View Slide

Examples
[text]
string string

View Slide

Examples
[number]
float localized string

View Slide

Examples
[date]
string
integer
array
DateTime Object
string
array
$builder->add('createdAt', 'date', array(
'input' => 'array',
'widget' => 'single_text',
));

View Slide

Which format do I get?
class MyDateType extends AbstractType
{
public function getParent()
{
return 'date';
}
public function buildForm(FormBuilderInterface $builder)
{
$builder->addEventListener(FormEvents::SUBMIT,
function (FormEvent $event) {
$data = $event->getForm()->getData();
}
);
}
}

View Slide

Normalized Format
[date]
string
integer
array
DateTime Object
string
array
DateTime Object
$builder->addEventListener(FormEvents::SUBMIT,
$data = $event->getForm()->getNormData();
}
);

View Slide

Tip
●
Whenever you create a custom type, decide:
●
Model format?
●
Normalized format?
●
View format?
http://www.flickr.com/photos/xverges/4622486563/

View Slide

In Practice

View Slide

Data Transformation
Form
model
data
view
data
normalized
data
model transformers view transformers
setData($data)

View Slide

Data Transformation
Form
model
data
view
data
normalized
data
model transformers view transformers
submit($data)
submit fields and map to view data

View Slide

Data Transformation
●
Symfony\Component\Form\DataTransformerInterface
●
bijective
●
transform($data)
●
reverseTransform($data)

View Slide

Example: ChoiceOrTextType

View Slide

[choiceortext]
string array
string
ValueToChoiceOrTextTransformer
Was the value submitted
through the choice
or the text field?

View Slide

[choiceortext]
string array
array

View Slide

Tip
The normalized data should contain as much
information as possible.

View Slide

Case 1: Existing Team Selected

View Slide

Case 1: Existing Team Selected
[choiceortext]
model
data
view
data
normalized
data
submit(array(
'choice' => 'Team 1',
'text' => '',
));
"Team 1"
array(
"choice" => "Team 1",
"text" => "",
)
array(
"choice" => "Team 1",
"text" => "",
)

View Slide

Case 2: New Team Created

View Slide

Case 2: New Team Created
[choiceortext]
model
data
view
data
normalized
data
submit(array(
'choice' => 'Other',
'text' => 'New Team',
));
"New Team"
array(
"choice" => "Other",
"text" => "New Team",
)
array(
"choice" => "Other",
"text" => "New Team",
)

View Slide

use Symfony\Component\Form\DataTransformerInterface;
class ValueToChoiceOrTextTransformer implements
DataTransformerInterface
{
public function transform($data)
{
...
}
public function reverseTransform($data)
{
...
}
}
Transformer Implementation

View Slide

Game:
Right or Wrong?

View Slide

Right or Wrong?
'Symfony'
bijective
'ynofmyS'

View Slide

Right or Wrong?
'SYmfony' 'symfony'
not bijective!
Solution: Events

View Slide

Right or Wrong?
['S','Y','m','f',
'o','n','y']
'SYmfony'
bijective

View Slide

Tip
Data transformers must always be bijective.
A == reverseTransform(transform(A))
In practice: changing the representation
string ↔ integer
array ↔ DateTime

View Slide

Tip
To make one-way changes, use events.
In practice: changing the content
filtering
sanitization
...

View Slide

Transformers and Type Reuse

View Slide

Example: CustomMoneyType
[custommoney]
Money Object string
float
custom same as in MoneyType

View Slide

Money Object
MoneyToFloatTransformer
[custommoney]
string
float
[money]
float
integer

View Slide

Back to the start...

View Slide

Prepopulation
employee
[form]
data
name
[text]
data
salary
[money]
data
birthDate
[birthdate]
data
year
[choice]
data
month
[choice]
data
day
[choice]
data
$employee = new Employee();
$employee->name = 'Jane';
$employee->salary = 110000.0;
$employee->birthDate = new DateTime('1941-09-09');
$form->setData($employee);

View Slide

Prepopulation
employee
[form]
Employee Object
name
[text]
model data
salary
[money]
model data
birthDate
[birthdate]
model data
year
[choice]
model data
month
[choice]
model data
day
[choice]
model data
?

View Slide

Submission
employee
[form]
Employee Object
name
[text]
"John"
salary
[money]
95000.0
birthDate
[birthdate]
DateTime Object
year
[choice]
1962
month
[choice]
5
day
[choice]
18
?

View Slide

http://www.flickr.com/photos/brandoncwarren/4164759025
Step 2:
Become Friends with Data Mappers

View Slide

Data what?

View Slide

Data Mapping
Data Mapping is the exchange of information
between a form's data and its fields.

View Slide

employee
[form]
model data
name
[text]
model data
salary
[money]
model data
birthDate
[birthdate]
model data
setData($empl->getSalary())
110000.0
setData($empl->getBirthDate())
DateTime Object
setData($empl)
Employee Object
setData($empl->getName())
"Jane"

View Slide

employee
[form]
Employee Object
name
[text]
salary
[money]
birthDate
[birthdate]
model data
model data
model data
$empl->setBirthDate($form->getData())
$empl->setSalary($form->getData())
$empl->setName($form->getData())
handleRequest($request)
"John"
95000.0
DateTime Object

View Slide

Data Mapping
●
Symfony\Component\Form\DataMapperInterface
●
bijective
●
mapFormsToData(array $forms, $data)
●
mapDataToForms($data, array $forms)

View Slide

Implementations
●
In Symfony:
●
PropertyPathMapper (getters/setters, arrays)
●
Ideas:
●
DomDocumentMapper (nodes of a DomDocument instance)
●
EAVMapper (attributes of EAV instances)

View Slide

Yeah, but...

View Slide

Yeah, but...
Terms and Conditions
1

View Slide

Terms and Conditions
$builder->add('terms', 'checkbox', array(
'mapped' => false,
));
order
[form]
Order Object
terms
[checkbox]
model data
$form->get('terms')->setData(true);
$form->get('terms')->getData();
$builder->add('terms', 'checkbox', array(
'mapped' => false,
'data' => true,
));
true

View Slide

Yeah, but...
Customized Getters/Setters
2

View Slide

$builder->add('name', 'text', array(
'property_path' => 'fullName',
));
employee
[form]
Employee Object
name
[text]
"Jane"
$form->setData($empl->getFullName())
$empl->setFullName($form->getData())

View Slide

'property_path' => 'fullName',
));
employee
[form]
Employee Object
name
[text]
"Jane"
$form->setData($empl->fullName)
$empl->fullName = $form->getData()

View Slide

Array Access
'property_path' => '[fullName]',
));
employee
[form]
Employee Object
name
[text]
"Jane"
$form->setData($empl['fullName'])
$empl['fullName'] = $form->getData()

View Slide

Chained Getters/Setters
'property_path' => 'personalDetails.fullName',
));
employee
[form]
Employee Object
name
[text]
"Jane"
$form->setData($empl->getPersonalDetails()->getFullName())
$empl->getPersonalDetails()->setFullName($form->getData())

View Slide

Mixed Chaining
'property_path' => '[personalDetails].fullName',
));
employee
[form]
Employee Object
name
[text]
"Jane"
$form->setData($empl['personalDetails']->getFullName())
$empl['personalDetails']->setFullName($form->getData())

View Slide

Yeah, but...
By-Reference Handling
3

View Slide

employee
[form]
Employee Object
address
[form]
Address Object
street
[text]
"4th Street"
city
[text]
"San Francisco"
$address->setCity($form->getData())
$address->setStreet($form->getData())
$empl->setAddress($address)

View Slide

employee
[form]
Employee Object
address
[form]
Address Object
street
[text]
"4th Street"
city
[text]
"San Francisco"
$empl->setAddress($address)
$builder->add('address', 'form', array(
'by_reference' => false,
));

View Slide

Yeah, but...
Non-Existent Accessors
4

View Slide

publishedAt
[date]
year
[choice]
month
[choice]
day
[choice]
DateTime Object
model data
model data
model data
setData($date->getYear())
setData($date)

View Slide

publishedAt
[date]
year
[choice]
month
[choice]
day
[choice]
DateTime Object
model data
model data
model data
array
array
setData($date['year'])
2012
setData($date['month'])
9
setData($date['day'])
27
setData($date)

View Slide

Recap

View Slide

Recap
●
Data Transformers
●
change the data's representation
●
Data Mappers
●
exchange data between forms and fields
●
Missing Piece: Events
●
change the data's content
●
dynamic forms!

View Slide

Step 3:
Events
http://www.sxc.hu/photo/813792

View Slide

Data Filtering

View Slide

Data Filtering
convert to lowercase on submit

View Slide

projectName
[text]
string string
string
Data Filtering
submit('Symfony');
"Symfony"
"Symfony"
"symfony" "symfony"
SUBMIT

View Slide

Data Filtering
$builder->get('projectName')->addEventListener(
FormEvents::SUBMIT,
$event->setData(strtolower($event->getData()));
}
);

View Slide

Data-Dependent Forms

View Slide

Data-Dependent Forms
●
Employee in a leading position:
●
Employee not in a leading position does not show this field.

View Slide

class EmployeeType extends AbstractType
{
private $employee;
public function __construct(Employee $employee)
{
$this->employee = $employee;
}
public function buildForm(FormBuilderInterface $builder,
array $options)
{
if ($this->employee->isInLeadingPosition()) {
$builder->add('department', 'text');
}
}
}

View Slide

class EmployeeType extends AbstractType
{
private $employee;
public function __construct(Employee $employee)
{
$this->employee = $employee;
}
array $options)
{
if ($this->employee->isInLeadingPosition()) {
$builder->add('department', 'text');
}
}
}

View Slide

Form Types vs. Instances
●
Form Types
●
exist once in your application
●
only dependencies that are the same for every form instance (e.g.
EntityManager)
●
Form Instances
●
exist multiple times with different data
●
data can (and often will) change after construction!!!

View Slide

employee
[form]
object
array
object
array
object
array
setData($empl)
PRE_SET_DATA
Employee Object Employee Object
department
Employee Object
setData($empl->getDept())

View Slide

array $options)
{
$builder->addEventListener(
FormEvents::PRE_SET_DATA,
if ($event->getData()->isInLeadingPosition()) {
$event->getForm()->add('department', 'text');
}
}
);
}

View Slide

http://www.flickr.com/photos/[email protected]/5428693024/
All together now

View Slide

employee
[form]
model data norm data view data
setData($empl)
PRE_SET_DATA
Employee Employee Employee
POST_SET_DATA

View Slide

employee
[form]
submit(array(...))
PRE_SUBMIT
Employee Employee Employee
POST_SUBMIT
submit(...)
SUBMIT

View Slide

That's it. Have fun! :)

View Slide

Questions?
http://joind.in/talk/view/10786
Bernhard Schussek
@webmozart
Thank you!

View Slide

3 Steps to Symfony2 Form Mastery

3 Steps to Symfony2 Form Mastery

Bernhard Schussek

More Decks by Bernhard Schussek

Other Decks in Programming

Featured

Transcript