Ce diaporama a bien été signalé.
Nous utilisons votre profil LinkedIn et vos données d’activité pour vous proposer des publicités personnalisées et pertinentes. Vous pouvez changer vos préférences de publicités à tout moment.
Samuele Lilli - DonCallisto
Rome, 28 October 2016
A journey into Symfony form component
Samuele Lilli - DonCallisto
WHO AM I?
Samuele Lilli - DonCallisto
Samuele Lilli
DonCallisto
Samuele Lilli - DonCallisto
Samuele Lilli - DonCallisto
Samuele Lilli - DonCallisto
Backend developer @
website: www.madisoft.it
tech blog: labs.madisoft.it
Samuele Lilli - DonCallisto
WE ARE HIRING!
(wanna join? ask us at the end of the talk or visit our website)
Samuele Lilli - DonCallisto
My first talk
Samuele Lilli - DonCallisto
https://joind.in/talk/5a6bd
Samuele Lilli - DonCallisto
FORM COMPONENT
(http://www.freepik.com/free-photos-vectors/smile - Smile vector designed by Fr...
Samuele Lilli - DonCallisto
FORM COMPONENT
(http://www.freepik.com/free-photos-vectors/smile - Smile vector designed by Fr...
Samuele Lilli - DonCallisto
FORM COMPONENT
(http://www.freepik.com/free-photos-vectors/smile - Smile vector designed by Fr...
Samuele Lilli - DonCallisto
FORM COMPONENT
Standalone component (install it via composer/packagist or github)
Samuele Lilli - DonCallisto
FORM COMPONENT
Standalone component (install it via composer/packagist or github)
Provides twi...
Samuele Lilli - DonCallisto
FORM COMPONENT
Standalone component (install it via composer/packagist or github)
Provides twi...
Samuele Lilli - DonCallisto
FORM COMPONENT
Standalone component (install it via composer/packagist or github)
Provides twi...
Samuele Lilli - DonCallisto
SUMMARY
EntityType
CollectionType
Form Data Filtering on Entity / Collection
Form Events
Form ...
Samuele Lilli - DonCallisto
ENTITY
TYPE
Samuele Lilli - DonCallisto
Use EntityType when you want list
or “associate” one or more
entities to another
Samuele Lilli - DonCallisto
class Product
{
// ….
/**
* @ORMManyToMany(targetEntity="Category",inversedBy="products")
*/
p...
Samuele Lilli - DonCallisto
class Product
{
// ….
/**
* @ORMManyToMany(targetEntity="Category",inversedBy="products")
*/
p...
Samuele Lilli - DonCallisto
class Category
{
// ….
public function addProduct(Product $product)
{
$this->products[] = $pro...
Samuele Lilli - DonCallisto
class CategoryType extends AbstractType
{
public function buildForm(FormBuilderInterface $buil...
Samuele Lilli - DonCallisto
Products are not associated to categories
Samuele Lilli - DonCallisto
http://stackoverflow.com/questions/9102063/symfony2-doctrine2-many-to-many-form-not-saving-ent...
Samuele Lilli - DonCallisto
http://stackoverflow.com/questions/9102063/symfony2-doctrine2-many-to-many-form-not-saving-ent...
Samuele Lilli - DonCallisto
That should not be the right answer
Never bend your needs to software limits (unless strictly ...
Samuele Lilli - DonCallisto
That should not be the right answer
Never bend your needs to software limits (unless strictly ...
Samuele Lilli - DonCallisto
Data consistency
Class Product
{
// ….
public function addCategory(Category $category)
{
if (!...
Samuele Lilli - DonCallisto
This should not be the right answer
Never bend your needs to software limits (unless strictly ...
Samuele Lilli - DonCallisto
public function buildForm(FormBuilderInterface $builder, array $options)
{
$builder
->add('nam...
Samuele Lilli - DonCallisto
WHY BY_REFERENCE => FALSE
It forces setter (adder) to be called on the parent element
As a rul...
Samuele Lilli - DonCallisto
BY_REFERENCE => TRUE
Name
Cat.
Name
Name
Name
$cat->getProducts()->get{0}->setName(‘bar’);
$ca...
Samuele Lilli - DonCallisto
BY_REFERENCE => FALSE
Name
Cat.
Name
Name
Name
$cat->getProducts()->get{0}->setName(‘bar’);
$c...
Samuele Lilli - DonCallisto
COLLECTION
TYPE
Samuele Lilli - DonCallisto
Use CollectionType when you want
to embed a collection of forms or
add/remove directly element...
Samuele Lilli - DonCallisto
Class User
{
/**
* @ORMOneToMany(targetEntity="Ticket", mappedBy="user", cascade={"persist"})
...
Samuele Lilli - DonCallisto
$builder
->add('username', TextType::class)
->add(tickets, CollectionType::class, [
'entry_typ...
Samuele Lilli - DonCallisto
Samuele Lilli - DonCallisto
Samuele Lilli - DonCallisto
Element not deleted!
Inthecourtofthecrimsonking-kingcrimson(1969)
Samuele Lilli - DonCallisto
Two possible solutions
“Manually” (programmatically) remove elements
Set orphanRemoval to true...
Samuele Lilli - DonCallisto
“Manually” (programmatically) remove elements
$originalTickets = new ArrayCollection();
foreac...
Samuele Lilli - DonCallisto
“Manually” (programmatically) remove elements
$originalTickets = new ArrayCollection();
foreac...
Samuele Lilli - DonCallisto
Set orphanRemoval to true on the attribute
/**
* @ORMOneToMany(targetEntity="Ticket", mappedBy...
Samuele Lilli - DonCallisto
Set orphanRemoval to true on the attribute
http://docs.doctrine-project.org/projects/doctrine-...
Samuele Lilli - DonCallisto
Set orphanRemoval to true on the attribute
public function passTicketsAction(User $yelding, Us...
Samuele Lilli - DonCallisto
Set orphanRemoval to true on the attribute
public function passTicketsAction(User $yelding, Us...
Samuele Lilli - DonCallisto
FORM DATA
FILTERING
(for entity and collection type)
Samuele Lilli - DonCallisto
EntityType
USE built-in queryBuilder option
public function buildForm(FormBuilderInterface $bu...
Samuele Lilli - DonCallisto
CollectionType
CollectionType does not have any queryBuilder option
Declare form as a service ...
Samuele Lilli - DonCallisto
EntityManager injection
public function __construct(EntityManager $em)
{
$this->fooRepo = $em-...
Samuele Lilli - DonCallisto
EntityManager as an option
public function buildForm(FormBuilderInterface $builder, array $opt...
Samuele Lilli - DonCallisto
Is repository the only way to filter data?
Do I need to create a repository on purpose?
Samuele Lilli - DonCallisto
NO
Samuele Lilli - DonCallisto
What if I need to access entity getters
for filter operations?
Samuele Lilli - DonCallisto
FORM
EVENTS
(overview)
Samuele Lilli - DonCallisto
->addEventListener(FormEvents::PRE_SET_DATA, function (FormEvent $e) {
/** @var $data User */
...
Samuele Lilli - DonCallisto
/**
* @ORMOneToMany(targetEntity="Ticket", mappedBy="user", cascade={"persist"}, orphanRemoval...
Samuele Lilli - DonCallisto
FORM EVENTS
$form = $this->createForm(UserType::class, $user);
$originalTickets = new ArrayCol...
Samuele Lilli - DonCallisto
FORM EVENTS
$form = $this->createForm(UserType::class, $user);
$originalTickets = new ArrayCol...
Samuele Lilli - DonCallisto
PRE_SET_DATA POST_SET_DATA
CONTROLLER
VIEW
NEW FORM
RENDER
FORM CREATION
Samuele Lilli - DonCallisto
PRE_SET_DATA POST_SET_DATA
CONTROLLER
VIEW
NEW FORM
RENDER
FORM CREATION
Samuele Lilli - DonCallisto
PRE_SET_DATA POST_SET_DATA
CONTROLLER
VIEW
NEW FORM
RENDER
FORM CREATION
Samuele Lilli - DonCallisto
PRE_SET_DATA POST_SET_DATA
CONTROLLER
VIEW
NEW FORM
RENDER
FORM CREATION
Samuele Lilli - DonCallisto
PRE_SET_DATA POST_SET_DATA
CONTROLLER
VIEW
NEW FORM
RENDER
FORM CREATION
Samuele Lilli - DonCallisto
PRE_SET_DATA POST_SET_DATA
CONTROLLER
VIEW
NEW FORM
RENDER
FORM CREATION
Samuele Lilli - DonCallisto
PRE_SET_DATA POST_SET_DATA
CONTROLLER
VIEW
NEW FORM
BIND
FORM POST
POST
PRE_SUBMIT SUBMIT POST...
Samuele Lilli - DonCallisto
PRE_SET_DATA POST_SET_DATA
CONTROLLER
VIEW
NEW FORM
BIND
FORM POST
POST
PRE_SUBMIT SUBMIT POST...
Samuele Lilli - DonCallisto
PRE_SET_DATA POST_SET_DATA
CONTROLLER
VIEW
NEW FORM
BIND
FORM POST
POST
PRE_SUBMIT SUBMIT POST...
Samuele Lilli - DonCallisto
PRE_SET_DATA POST_SET_DATA
CONTROLLER
VIEW
NEW FORM
BIND
FORM POST
POST
PRE_SUBMIT SUBMIT POST...
Samuele Lilli - DonCallisto
PRE_SET_DATA POST_SET_DATA
CONTROLLER
VIEW
NEW FORM
BIND
FORM POST
POST
PRE_SUBMIT SUBMIT POST...
Samuele Lilli - DonCallisto
PRE_SET_DATA POST_SET_DATA
CONTROLLER
VIEW
NEW FORM
BIND
FORM POST
POST
PRE_SUBMIT SUBMIT POST...
Samuele Lilli - DonCallisto
PRE_SET_DATA POST_SET_DATA
CONTROLLER
VIEW
NEW FORM
BIND
FORM POST
POST
PRE_SUBMIT SUBMIT POST...
Samuele Lilli - DonCallisto
PRE_SET_DATA POST_SET_DATA
CONTROLLER
VIEW
NEW FORM
BIND
FORM POST
POST
PRE_SUBMIT SUBMIT POST...
Samuele Lilli - DonCallisto
PRE_SET_DATA POST_SET_DATA
CONTROLLER
VIEW
NEW FORM
BIND
FORM POST
POST
PRE_SUBMIT SUBMIT POST...
Samuele Lilli - DonCallisto
PRE_SET_DATA POST_SET_DATA
CONTROLLER
VIEW
NEW FORM
BIND
FORM POST
POST
PRE_SUBMIT SUBMIT POST...
Samuele Lilli - DonCallisto
TIP
Every group of events it’s called from START to
END on every FORM. This means that if you
...
Samuele Lilli - DonCallisto
BECAUSE OF THIS
Samuele Lilli - DonCallisto
NEVER SET
PARENT DATA
FROM CHILD FORM
Samuele Lilli - DonCallisto
EVER!
Samuele Lilli - DonCallisto
DATA TYPES
Samuele Lilli - DonCallisto
DATA TYPES
MODEL DATA
NORM DATA
VIEW DATA
Samuele Lilli - DonCallisto
MODEL DATA
Main data type of PRE_SET_DATA and POST_SET_DATA
Reppresent data of underlying obje...
Samuele Lilli - DonCallisto
NORM DATA
Main data type of SUBMIT event
Reppresent data after normalization. Commonly not use...
Samuele Lilli - DonCallisto
VIEW DATA
Main data type of POST_SUBMIT event
Reppresent data presented to the View. It’s the ...
Samuele Lilli - DonCallisto
DATA
TRANSFORMERS
Samuele Lilli - DonCallisto
MODEL
TRANSFORMER
Samuele Lilli - DonCallisto
ENTITY
MODEL DATA NORM DATA
MODEL TRANSFORMER
NEW FORM BIND
TRANSFORM
REVERSE
TRANSFORM
Samuele Lilli - DonCallisto
ENTITY
MODEL DATA NORM DATA
NEW FORM BIND
TRANSFORM
REVERSE
TRANSFORM
MODEL TRANSFORMER
Samuele Lilli - DonCallisto
ENTITY - MODEL DATA
/**
* @ORMColumn(type="array", nullable=true)
*/
protected $tags;
Samuele Lilli - DonCallisto
ENTITY
MODEL DATA NORM DATA
NEW FORM BIND
TRANSFORM
REVERSE
TRANSFORM
MODEL TRANSFORMER
Samuele Lilli - DonCallisto
FORM FIELD
$builder->add('tags', TextType::class)
Samuele Lilli - DonCallisto
Since model data (array) is
different from norm data (text)
we need a model transformer
Samuele Lilli - DonCallisto
$builder->add('tags', TextType::class);
$builder->get(‘tags’)->addModelTransformer(...);
FORM ...
Samuele Lilli - DonCallisto
ENTITY
MODEL DATA NORM DATA
NEW FORM BIND
TRANSFORM
REVERSE
TRANSFORM
MODEL TRANSFORMER
Samuele Lilli - DonCallisto
TRANSFORM
public function transform($tagsArray)
{
// transform the array to string
if (null ==...
Samuele Lilli - DonCallisto
ENTITY
MODEL DATA NORM DATA
NEW FORM BIND
TRANSFORM
REVERSE
TRANSFORM
MODEL TRANSFORMER
Samuele Lilli - DonCallisto
public function reverseTransform($tagsString)
{
// transform the string back to an array
if (!...
Samuele Lilli - DonCallisto
VIEW
TRANSFORMER
Samuele Lilli - DonCallisto
VIEW
NORM DATA VIEW DATA
CREATE VIEWPOST
TRANSFORM
REVERSE
TRANSFORM
VIEW TRANSFORMER
Samuele Lilli - DonCallisto
DATE TYPE (TRANSFORM)
// Transforms a normalized date into a localized date string/array)
publ...
Samuele Lilli - DonCallisto
// Transforms a localized date string/array into a normalized date.
public function reverseTra...
Samuele Lilli - DonCallisto
FORM
EVENTS
(reprise)
Samuele Lilli - DonCallisto
PRE SET DATA EVENT
Modify data given during pre-population.
Don’t modify form data directly bu...
Samuele Lilli - DonCallisto
->addEventListener(FormEvents::PRE_SET_DATA, function (FormEvent $e) {
/** @var $data User */
...
Samuele Lilli - DonCallisto
->addEventListener(FormEvents::PRE_SET_DATA, function (FormEvent $e) {
if ($e->getData()->canH...
Samuele Lilli - DonCallisto
Read pre-populated form data
Don’t remove fields that you’ve setted “statically” on form
build...
Samuele Lilli - DonCallisto
class FooType extends BarType
{
// ….
// email field added in BarType
->addEventListener(FormE...
Samuele Lilli - DonCallisto
Change data from the request
Add/Remove form fields
USED FOR
EVENT DATA
REQUEST DATA (ARRAY)
P...
Samuele Lilli - DonCallisto
private $canModifyEmail = true;
->addEventListener(FormEvents::PRE_SET_DATA, function (FormEve...
Samuele Lilli - DonCallisto
Modify NormData
No real example will be showed
EVENT DATA
NORM DATA
SUBMIT EVENT
USED FOR
Samuele Lilli - DonCallisto
Fetch data after denormalization
Even if faster to read “final” data here, don’t implement any...
Samuele Lilli - DonCallisto
POST SUBMIT
$builder->addEventListener(FormEvents::POST_SUBMIT, function (FormEvent $event) us...
Samuele Lilli - DonCallisto
VALUE
OBJECTS
Samuele Lilli - DonCallisto
Two object are equal if their
all fields are equal, not
necessary if they are the
same object
Samuele Lilli - DonCallisto
NO SETTERS
Samuele Lilli - DonCallisto
CONSTRUCTOR
Samuele Lilli - DonCallisto
Class FooBar
{
private $foo;
private $bar;
public function __construct($foo, $bar)
{
$this->fo...
Samuele Lilli - DonCallisto
Class FooBarType extends AbstractType
{
public function buildForm(FormBuilderInterface $builde...
Samuele Lilli - DonCallisto
PROPERTY
PATH
Samuele Lilli - DonCallisto
Class User
{
//….
/*
* @ORMOneToOne(targetEntity=”Address”, inversedBy=”user”)
*/
protected $a...
Samuele Lilli - DonCallisto
Class Address
{
//….
/**
* @ORMOneToOne(targetEntity=”User”, mappedBy=”address”)
*/
protected ...
Samuele Lilli - DonCallisto
DON’T CREATE AN
EMBEDDED FORM ON
PURPOSE
Samuele Lilli - DonCallisto
DON’T USE
UNMAPPED FIELDS
AND FORM EVENTS
Samuele Lilli - DonCallisto
USE PROPERTY PATH!
Samuele Lilli - DonCallisto
Class UserType extends AbstractType
{
public function buildForm(FormBuilderInterface $builder,...
QUESTIONS?
Samuele Lilli - DonCallisto
THANK YOU
Prochain SlideShare
Chargement dans…5
×

Symfony day 2016

A journey into symfony form component

Livres associés

Gratuit avec un essai de 30 jours de Scribd

Tout voir
  • Soyez le premier à commenter

Symfony day 2016

  1. 1. Samuele Lilli - DonCallisto Rome, 28 October 2016 A journey into Symfony form component
  2. 2. Samuele Lilli - DonCallisto WHO AM I?
  3. 3. Samuele Lilli - DonCallisto Samuele Lilli DonCallisto
  4. 4. Samuele Lilli - DonCallisto
  5. 5. Samuele Lilli - DonCallisto
  6. 6. Samuele Lilli - DonCallisto Backend developer @ website: www.madisoft.it tech blog: labs.madisoft.it
  7. 7. Samuele Lilli - DonCallisto WE ARE HIRING! (wanna join? ask us at the end of the talk or visit our website)
  8. 8. Samuele Lilli - DonCallisto My first talk
  9. 9. Samuele Lilli - DonCallisto https://joind.in/talk/5a6bd
  10. 10. Samuele Lilli - DonCallisto FORM COMPONENT (http://www.freepik.com/free-photos-vectors/smile - Smile vector designed by Freepik)
  11. 11. Samuele Lilli - DonCallisto FORM COMPONENT (http://www.freepik.com/free-photos-vectors/smile - Smile vector designed by Freepik)
  12. 12. Samuele Lilli - DonCallisto FORM COMPONENT (http://www.freepik.com/free-photos-vectors/smile - Smile vector designed by Freepik)
  13. 13. Samuele Lilli - DonCallisto FORM COMPONENT Standalone component (install it via composer/packagist or github)
  14. 14. Samuele Lilli - DonCallisto FORM COMPONENT Standalone component (install it via composer/packagist or github) Provides twig facilities for render labels/fields/errors
  15. 15. Samuele Lilli - DonCallisto FORM COMPONENT Standalone component (install it via composer/packagist or github) Provides twig facilities for render labels/fields/errors Handling for you data submission (bind to entity if any, validation, data transformations, …)
  16. 16. Samuele Lilli - DonCallisto FORM COMPONENT Standalone component (install it via composer/packagist or github) Provides twig facilities for render labels/fields/errors Handling for you data submission (bind to entity if any, validation, data transformations, …) Provides a bunch of built-in types
  17. 17. Samuele Lilli - DonCallisto SUMMARY EntityType CollectionType Form Data Filtering on Entity / Collection Form Events Form Data Types Data Transformers Value Objects Property Path
  18. 18. Samuele Lilli - DonCallisto ENTITY TYPE
  19. 19. Samuele Lilli - DonCallisto Use EntityType when you want list or “associate” one or more entities to another
  20. 20. Samuele Lilli - DonCallisto class Product { // …. /** * @ORMManyToMany(targetEntity="Category",inversedBy="products") */ protected $categories; class Category { // …. /** *@ORMManyToMany(targetEntity="Product",mappedBy="categories") */ protected $products;
  21. 21. Samuele Lilli - DonCallisto class Product { // …. /** * @ORMManyToMany(targetEntity="Category",inversedBy="products") */ protected $categories; class Category { // …. /** *@ORMManyToMany(targetEntity="Product",mappedBy="categories") */ protected $products; OWNING SIDE INVERSED SIDE
  22. 22. Samuele Lilli - DonCallisto class Category { // …. public function addProduct(Product $product) { $this->products[] = $product; return $this; } public function removeProduct(Product $product) { $this->products->removeElement($product); }
  23. 23. Samuele Lilli - DonCallisto class CategoryType extends AbstractType { public function buildForm(FormBuilderInterface $builder, array $options) { $builder ->add('name', TextType::class) ->add('products', EntityType::class, [ 'class' => Product::class, 'multiple' => true, 'required' => false, ]); } //….
  24. 24. Samuele Lilli - DonCallisto Products are not associated to categories
  25. 25. Samuele Lilli - DonCallisto http://stackoverflow.com/questions/9102063/symfony2-doctrine2-many-to-many-form-not-saving-entities
  26. 26. Samuele Lilli - DonCallisto http://stackoverflow.com/questions/9102063/symfony2-doctrine2-many-to-many-form-not-saving-entities
  27. 27. Samuele Lilli - DonCallisto That should not be the right answer Never bend your needs to software limits (unless strictly necessary) Doctrine looks only for changes ONLY on the owning side of association, so those adds will not take place. Take care yourself for data consistency (during objects lifecycle, ensure that all references are setted well in both sides). This concept is not ORM-related. We didn’t add by_reference => false into into FormType.
  28. 28. Samuele Lilli - DonCallisto That should not be the right answer Never bend your needs to software limits (unless strictly necessary) Doctrine looks only for changes ONLY on the owning side of association, so those adds will not take place. Take care yourself for data consistency (during objects lifecycle, ensure that all references are setted well in both sides). This concept is not ORM-related. We didn’t add by_reference => false into into FormType.
  29. 29. Samuele Lilli - DonCallisto Data consistency Class Product { // …. public function addCategory(Category $category) { if (!$this->categories->contains($category)) { $this->categories[] = $category; $category->addProduct($this); } return $this; } public function removeCategory(Category $category) { if ($this->categories->contains($category)) { $this->categories->removeElement($category); $category->removeProduct($this); } } Class Category { // …. public function addProduct(Product $product) { if (!$this->products->contains($product)) { $this->products[] = $product; $product->addCategory($this); } return $this; } public function removeProduct(Product $product) { if ($this->products->contains($product)) { $this->products->removeElement($product); $product->removeCategory($this); } }
  30. 30. Samuele Lilli - DonCallisto This should not be the right answer Never bend your needs to software limits (unless strictly necessary) Doctrine looks only for changes ONLY on the owning side of association, so those adds will not take place. √ Take care yourself for data consistency (during objects lifecycle, ensure that all references are setted well in both sides). This concept is not ORM-related. √ We didn’t add by_reference => false into into FormType.
  31. 31. Samuele Lilli - DonCallisto public function buildForm(FormBuilderInterface $builder, array $options) { $builder ->add('name', TextType::class) ->add('products', EntityType::class, [ 'class' => Product::class, 'multiple' => true, 'required' => false, 'by_reference' => false, ]); } by_refence => false
  32. 32. Samuele Lilli - DonCallisto WHY BY_REFERENCE => FALSE It forces setter (adder) to be called on the parent element As a rule of thumb, set ALWAYS by_reference to false when dealing with objects (ArrayCollection included)
  33. 33. Samuele Lilli - DonCallisto BY_REFERENCE => TRUE Name Cat. Name Name Name $cat->getProducts()->get{0}->setName(‘bar’); $cat->getProducts()->get{1}->setName(‘foobar’); $product3 = new Product(); $product3->setName(); $cat->getProducts()->add($product3); $cat->setName(‘foo’);
  34. 34. Samuele Lilli - DonCallisto BY_REFERENCE => FALSE Name Cat. Name Name Name $cat->getProducts()->get{0}->setName(‘bar’); $cat->getProducts()->get{1}->setName(‘foobar’); $product3 = new Product(); $product3>setName(); $cat->addProduct($product3); $cat->setName(‘foo’);
  35. 35. Samuele Lilli - DonCallisto COLLECTION TYPE
  36. 36. Samuele Lilli - DonCallisto Use CollectionType when you want to embed a collection of forms or add/remove directly elements from collection
  37. 37. Samuele Lilli - DonCallisto Class User { /** * @ORMOneToMany(targetEntity="Ticket", mappedBy="user", cascade={"persist"}) */ protected $tickets; public function addTickets(Ticket $ticket) { if (!$this->tickets->contains($ticket)) { $this->tickets[] = $ticket; $ticket->setUser($this); } return $this; } public function removeTicket(Ticket $ticket) { $this->tickets->removeElement($ticket); }
  38. 38. Samuele Lilli - DonCallisto $builder ->add('username', TextType::class) ->add(tickets, CollectionType::class, [ 'entry_type' => TicketType::class, 'allow_add' => true, 'allow_delete' => true, 'prototype' => true, 'by_reference' => false, ]); UserType
  39. 39. Samuele Lilli - DonCallisto
  40. 40. Samuele Lilli - DonCallisto
  41. 41. Samuele Lilli - DonCallisto Element not deleted!
  42. 42. Inthecourtofthecrimsonking-kingcrimson(1969)
  43. 43. Samuele Lilli - DonCallisto Two possible solutions “Manually” (programmatically) remove elements Set orphanRemoval to true on the attribute If the relationship was ManyToMany and User was the owning side, no troubles
  44. 44. Samuele Lilli - DonCallisto “Manually” (programmatically) remove elements $originalTickets = new ArrayCollection(); foreach ($user->getTickets() as $ticket) { $originalTickets->add($ticket); } if ($this->isFormSubmittedAndValid($form, $request)) { foreach ($originalTickets as $originalTicket) { if (!$user->getTickets()->contains($originalTicket)) { $em->remove($originalTicket); } } }
  45. 45. Samuele Lilli - DonCallisto “Manually” (programmatically) remove elements $originalTickets = new ArrayCollection(); foreach ($user->getTickets() as $ticket) { $originalTickets->add($ticket); } if ($this->isFormSubmittedAndValid($form, $request)) { foreach ($originalTickets as $originalTicket) { if (!$user->getTickets()->contains($originalTicket)) { $em->remove($originalTicket); } } }
  46. 46. Samuele Lilli - DonCallisto Set orphanRemoval to true on the attribute /** * @ORMOneToMany(targetEntity="Ticket", mappedBy="user", cascade={"persist"}, orphanRemoval=true) */ protected $tickets; NOT RECOMMENDED
  47. 47. Samuele Lilli - DonCallisto Set orphanRemoval to true on the attribute http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/working-with-associations.html
  48. 48. Samuele Lilli - DonCallisto Set orphanRemoval to true on the attribute public function passTicketsAction(User $yelding, User $beneficiary) { foreach ($yelding->getTickets() as $ticket) { $yelding->removeTicket($ticket); $beneficiary->addTicket($ticket); } }
  49. 49. Samuele Lilli - DonCallisto Set orphanRemoval to true on the attribute public function passTicketsAction(User $yelding, User $beneficiary) { foreach ($yelding->getTickets() as $ticket) { $beneficiary->addTicket($ticket); // OR → $ticket->setUser($beneficiary); } }
  50. 50. Samuele Lilli - DonCallisto FORM DATA FILTERING (for entity and collection type)
  51. 51. Samuele Lilli - DonCallisto EntityType USE built-in queryBuilder option public function buildForm(FormBuilderInterface $builder, array $options) { $builder ->add(‘foo’, EntityType::class, [ // …. ‘queryBuilder’ => function (FooRepo $fooRepo) { return $fooRepo->filterFunction(); } ]); }
  52. 52. Samuele Lilli - DonCallisto CollectionType CollectionType does not have any queryBuilder option Declare form as a service an inject repository (entity manager) This is the preferred way if you need the repo Pass repository as an option Usually, options are used for what you cannot inject into service
  53. 53. Samuele Lilli - DonCallisto EntityManager injection public function __construct(EntityManager $em) { $this->fooRepo = $em->getRepository(Foo::class); } public function buildForm(FormBuilderInterface $builder, array $options) { $builder->add(‘foo’, CollectionType::class, [ // …. 'data' => $this->fooRepo->filterFunction() ]); }
  54. 54. Samuele Lilli - DonCallisto EntityManager as an option public function buildForm(FormBuilderInterface $builder, array $options) { $fooRepo = $options[‘fooRepo’]; $builder->add(‘foo’, CollectionType::class, [ // …. 'data' => $fooRepo>filterFunction() ]); }
  55. 55. Samuele Lilli - DonCallisto Is repository the only way to filter data? Do I need to create a repository on purpose?
  56. 56. Samuele Lilli - DonCallisto NO
  57. 57. Samuele Lilli - DonCallisto What if I need to access entity getters for filter operations?
  58. 58. Samuele Lilli - DonCallisto FORM EVENTS (overview)
  59. 59. Samuele Lilli - DonCallisto ->addEventListener(FormEvents::PRE_SET_DATA, function (FormEvent $e) { /** @var $data User */ $data = $e->getData(); $form = $e->getForm(); $today = new DateTime(); $criteria = Criteria::create() ->where(Criteria::expr()->gte('date', $today)); $form->add('tickets', CollectionType::class, [ // …. 'data' => $data->getTickets()->matching($criteria) ]); }); }); FORM EVENTS
  60. 60. Samuele Lilli - DonCallisto /** * @ORMOneToMany(targetEntity="Ticket", mappedBy="user", cascade={"persist"}, orphanRemoval=true) */ protected $tickets; ● All tickets (entities) filtered out in the event will be removed! ● Remove orphanRemoval option from the attribute and handle collection yourself FORM EVENTS
  61. 61. Samuele Lilli - DonCallisto FORM EVENTS $form = $this->createForm(UserType::class, $user); $originalTickets = new ArrayCollection(); foreach ($form->get('tickets')->getData() as $ticket) { $originalTickets->add($ticket); } if ($this->isFormSubmittedAndValid($form, $request)) { foreach ($originalTickets as $originalTicket) { if ($user->getTickets()->contains($originalTicket)) { continue; } $em->remove($originalTicket); }
  62. 62. Samuele Lilli - DonCallisto FORM EVENTS $form = $this->createForm(UserType::class, $user); $originalTickets = new ArrayCollection(); foreach ($form->get('tickets')->getData() as $ticket) { $originalTickets->add($ticket); } if ($this->isFormSubmittedAndValid($form, $request)) { foreach ($originalTickets as $originalTicket) { if ($user->getTickets()->contains($originalTicket)) { continue; } $em->remove($originalTicket); }
  63. 63. Samuele Lilli - DonCallisto PRE_SET_DATA POST_SET_DATA CONTROLLER VIEW NEW FORM RENDER FORM CREATION
  64. 64. Samuele Lilli - DonCallisto PRE_SET_DATA POST_SET_DATA CONTROLLER VIEW NEW FORM RENDER FORM CREATION
  65. 65. Samuele Lilli - DonCallisto PRE_SET_DATA POST_SET_DATA CONTROLLER VIEW NEW FORM RENDER FORM CREATION
  66. 66. Samuele Lilli - DonCallisto PRE_SET_DATA POST_SET_DATA CONTROLLER VIEW NEW FORM RENDER FORM CREATION
  67. 67. Samuele Lilli - DonCallisto PRE_SET_DATA POST_SET_DATA CONTROLLER VIEW NEW FORM RENDER FORM CREATION
  68. 68. Samuele Lilli - DonCallisto PRE_SET_DATA POST_SET_DATA CONTROLLER VIEW NEW FORM RENDER FORM CREATION
  69. 69. Samuele Lilli - DonCallisto PRE_SET_DATA POST_SET_DATA CONTROLLER VIEW NEW FORM BIND FORM POST POST PRE_SUBMIT SUBMIT POST_SUBMIT IS VALID PERSIST
  70. 70. Samuele Lilli - DonCallisto PRE_SET_DATA POST_SET_DATA CONTROLLER VIEW NEW FORM BIND FORM POST POST PRE_SUBMIT SUBMIT POST_SUBMIT IS VALID PERSIST
  71. 71. Samuele Lilli - DonCallisto PRE_SET_DATA POST_SET_DATA CONTROLLER VIEW NEW FORM BIND FORM POST POST PRE_SUBMIT SUBMIT POST_SUBMIT IS VALID PERSIST
  72. 72. Samuele Lilli - DonCallisto PRE_SET_DATA POST_SET_DATA CONTROLLER VIEW NEW FORM BIND FORM POST POST PRE_SUBMIT SUBMIT POST_SUBMIT IS VALID PERSIST
  73. 73. Samuele Lilli - DonCallisto PRE_SET_DATA POST_SET_DATA CONTROLLER VIEW NEW FORM BIND FORM POST POST PRE_SUBMIT SUBMIT POST_SUBMIT IS VALID PERSIST
  74. 74. Samuele Lilli - DonCallisto PRE_SET_DATA POST_SET_DATA CONTROLLER VIEW NEW FORM BIND FORM POST POST PRE_SUBMIT SUBMIT POST_SUBMIT IS VALID PERSIST
  75. 75. Samuele Lilli - DonCallisto PRE_SET_DATA POST_SET_DATA CONTROLLER VIEW NEW FORM BIND FORM POST POST PRE_SUBMIT SUBMIT POST_SUBMIT IS VALID PERSIST
  76. 76. Samuele Lilli - DonCallisto PRE_SET_DATA POST_SET_DATA CONTROLLER VIEW NEW FORM BIND FORM POST POST PRE_SUBMIT SUBMIT POST_SUBMIT IS VALID PERSIST
  77. 77. Samuele Lilli - DonCallisto PRE_SET_DATA POST_SET_DATA CONTROLLER VIEW NEW FORM BIND FORM POST POST PRE_SUBMIT SUBMIT POST_SUBMIT IS VALID PERSIST
  78. 78. Samuele Lilli - DonCallisto PRE_SET_DATA POST_SET_DATA CONTROLLER VIEW NEW FORM BIND FORM POST POST PRE_SUBMIT SUBMIT POST_SUBMIT IS VALID PERSIST
  79. 79. Samuele Lilli - DonCallisto TIP Every group of events it’s called from START to END on every FORM. This means that if you have a chain of embedded form, all events are called starting from innermost forms, going up to parent form, ending on top form
  80. 80. Samuele Lilli - DonCallisto BECAUSE OF THIS
  81. 81. Samuele Lilli - DonCallisto NEVER SET PARENT DATA FROM CHILD FORM
  82. 82. Samuele Lilli - DonCallisto EVER!
  83. 83. Samuele Lilli - DonCallisto DATA TYPES
  84. 84. Samuele Lilli - DonCallisto DATA TYPES MODEL DATA NORM DATA VIEW DATA
  85. 85. Samuele Lilli - DonCallisto MODEL DATA Main data type of PRE_SET_DATA and POST_SET_DATA Reppresent data of underlying object. In previous example with product form, product field model data is a Product object. If field type is the same of underlying data, NORM DATA will be the same of MODEL DATA If field type is not the same of underlying data, you must use ModelTransformer to transform MODEL DATA into NORM DATA and vice versa (Don’t worry, we will talk about transformers next!)
  86. 86. Samuele Lilli - DonCallisto NORM DATA Main data type of SUBMIT event Reppresent data after normalization. Commonly not used directly. If on MODEL DATA is not present any ModelTransform, this is the same of MODEL DATA and so the same of underlying object. If NORM DATA isn’t the same of view reppresentation, you must use ViewTransformer to transform NORM DATA into VIEW DATA and vice versa
  87. 87. Samuele Lilli - DonCallisto VIEW DATA Main data type of POST_SUBMIT event Reppresent data presented to the View. It’s the data type that you get when you post the form. If on VIEW DATA is not present any ViewTransformer, this is the same of NORM DATA.
  88. 88. Samuele Lilli - DonCallisto DATA TRANSFORMERS
  89. 89. Samuele Lilli - DonCallisto MODEL TRANSFORMER
  90. 90. Samuele Lilli - DonCallisto ENTITY MODEL DATA NORM DATA MODEL TRANSFORMER NEW FORM BIND TRANSFORM REVERSE TRANSFORM
  91. 91. Samuele Lilli - DonCallisto ENTITY MODEL DATA NORM DATA NEW FORM BIND TRANSFORM REVERSE TRANSFORM MODEL TRANSFORMER
  92. 92. Samuele Lilli - DonCallisto ENTITY - MODEL DATA /** * @ORMColumn(type="array", nullable=true) */ protected $tags;
  93. 93. Samuele Lilli - DonCallisto ENTITY MODEL DATA NORM DATA NEW FORM BIND TRANSFORM REVERSE TRANSFORM MODEL TRANSFORMER
  94. 94. Samuele Lilli - DonCallisto FORM FIELD $builder->add('tags', TextType::class)
  95. 95. Samuele Lilli - DonCallisto Since model data (array) is different from norm data (text) we need a model transformer
  96. 96. Samuele Lilli - DonCallisto $builder->add('tags', TextType::class); $builder->get(‘tags’)->addModelTransformer(...); FORM FIELD
  97. 97. Samuele Lilli - DonCallisto ENTITY MODEL DATA NORM DATA NEW FORM BIND TRANSFORM REVERSE TRANSFORM MODEL TRANSFORMER
  98. 98. Samuele Lilli - DonCallisto TRANSFORM public function transform($tagsArray) { // transform the array to string if (null === $tagsArray) { return ''; } return implode(',', $tagsArray); }
  99. 99. Samuele Lilli - DonCallisto ENTITY MODEL DATA NORM DATA NEW FORM BIND TRANSFORM REVERSE TRANSFORM MODEL TRANSFORMER
  100. 100. Samuele Lilli - DonCallisto public function reverseTransform($tagsString) { // transform the string back to an array if (!$tagsString) { return []; } return explode(',', $tagsString); } REVERSE TRANSFORM
  101. 101. Samuele Lilli - DonCallisto VIEW TRANSFORMER
  102. 102. Samuele Lilli - DonCallisto VIEW NORM DATA VIEW DATA CREATE VIEWPOST TRANSFORM REVERSE TRANSFORM VIEW TRANSFORMER
  103. 103. Samuele Lilli - DonCallisto DATE TYPE (TRANSFORM) // Transforms a normalized date into a localized date string/array) public function transform($dateTime) { if (null === $dateTime) { return ''; } if (!$dateTime instanceof DateTimeInterface) { throw new TransformationFailedException('Expected a DateTimeInterface.'); } $value = $this->getIntlDateFormatter()->format($dateTime->getTimestamp()); if (intl_get_error_code() != 0) { throw new TransformationFailedException(intl_get_error_message()); } return $value; }
  104. 104. Samuele Lilli - DonCallisto // Transforms a localized date string/array into a normalized date. public function reverseTransform($value) { if (!is_string($value)) { throw new TransformationFailedException('Expected a string.'); } if ('' === $value) { return; } $timestamp = $this->getIntlDateFormatter()->parse($value); // …. try { $dateTime = new DateTime(sprintf('@%s', $timestamp)); } catch (Exception $e) { throw new TransformationFailedException($e->getMessage(), $e->getCode(), $e); } // …. return $dateTime; } DATE TYPE ( REVERSE TRANSFORM)
  105. 105. Samuele Lilli - DonCallisto FORM EVENTS (reprise)
  106. 106. Samuele Lilli - DonCallisto PRE SET DATA EVENT Modify data given during pre-population. Don’t modify form data directly but modify event data instead. Add/Remove form fields USED FOR EVENT DATA MODEL DATA
  107. 107. Samuele Lilli - DonCallisto ->addEventListener(FormEvents::PRE_SET_DATA, function (FormEvent $e) { /** @var $data User */ $data = $e->getData(); // ← MODEL DATA $form = $e->getForm(); $today = new DateTime(); $criteria = Criteria::create() ->where(Criteria::expr()->gte('date', $today)); $form->add(‘tickets’, CollectionType::class, [ // …. 'data' => $data->getTickets()->matching($criteria) ]); }); }); PRE_SET_DATA
  108. 108. Samuele Lilli - DonCallisto ->addEventListener(FormEvents::PRE_SET_DATA, function (FormEvent $e) { if ($e->getData()->canHandleMail()) { // ← MODEL DATA $e->getForm()->add(‘email’, EmailType::class); } }); }); PRE_SET_DATA
  109. 109. Samuele Lilli - DonCallisto Read pre-populated form data Don’t remove fields that you’ve setted “statically” on form building process. Use PRE_SET_DATA and implement the logic about fields. One exception: you are extending from a parent form where you cannot control yourself the logic. USED FOR EVENT DATA MODEL DATA POST SET DATA EVENT
  110. 110. Samuele Lilli - DonCallisto class FooType extends BarType { // …. // email field added in BarType ->addEventListener(FormEvents::POST_SET_DATA, function (FormEvent $e) { if (!$e->getData()->canHandleMail()) { // ← MODEL DATA $e->getForm()->remove(‘email’); } }); }); POST_SET_DATA
  111. 111. Samuele Lilli - DonCallisto Change data from the request Add/Remove form fields USED FOR EVENT DATA REQUEST DATA (ARRAY) PRE SUBMIT EVENT
  112. 112. Samuele Lilli - DonCallisto private $canModifyEmail = true; ->addEventListener(FormEvents::PRE_SET_DATA, function (FormEvent $e) { $this->canModifyEmail = $e->getData()->canModifyEmail(); $e->getForm()->add(‘email, EmailType::class, [ // …. ‘attr’ => [ ‘disabled’ => !$this->canModifyEmail ], ]); }) ->addEventListener(FormEvents::PRE_SUBMIT, function (FormEvent $e) { if (!$this->canModifyEmail) { $e->getForm()->remove(‘email’); } }); }); PRE_SUBMIT
  113. 113. Samuele Lilli - DonCallisto Modify NormData No real example will be showed EVENT DATA NORM DATA SUBMIT EVENT USED FOR
  114. 114. Samuele Lilli - DonCallisto Fetch data after denormalization Even if faster to read “final” data here, don’t implement any business logic → hard to test and break SRP. If you need to modify model data, do it elsewhere just after isValid call. USED FOR EVENT DATA VIEW DATA POST SUBMIT EVENT
  115. 115. Samuele Lilli - DonCallisto POST SUBMIT $builder->addEventListener(FormEvents::POST_SUBMIT, function (FormEvent $event) use ($handler) { $delete = $event->getForm()->has('delete') ? $event->getForm()->get('delete')->getData() : false; $entity = $event->getForm()->getParent()->getData(); if (!$delete) { return; } $handler->remove($entity, $event->getForm()->getName()); }); Vichuploader-bundle
  116. 116. Samuele Lilli - DonCallisto VALUE OBJECTS
  117. 117. Samuele Lilli - DonCallisto Two object are equal if their all fields are equal, not necessary if they are the same object
  118. 118. Samuele Lilli - DonCallisto NO SETTERS
  119. 119. Samuele Lilli - DonCallisto CONSTRUCTOR
  120. 120. Samuele Lilli - DonCallisto Class FooBar { private $foo; private $bar; public function __construct($foo, $bar) { $this->foo = $foo; $this->bar = $bar; } public function getFoo(){ … } public function getBar(){ … } }
  121. 121. Samuele Lilli - DonCallisto Class FooBarType extends AbstractType { public function buildForm(FormBuilderInterface $builder, array $options) { $builder ->add(‘foo’) ->add(‘bar’); } public function configureOptions(OptionsResolver $resolver) { $resolver->setDefaults([ ‘empty_data’ => function (FormInterface $interface) { return new FooBar($interface->get(‘foo’)->getData(), $interface->get(‘bar’)->getData()); }, ]); } }
  122. 122. Samuele Lilli - DonCallisto PROPERTY PATH
  123. 123. Samuele Lilli - DonCallisto Class User { //…. /* * @ORMOneToOne(targetEntity=”Address”, inversedBy=”user”) */ protected $address; //…. }
  124. 124. Samuele Lilli - DonCallisto Class Address { //…. /** * @ORMOneToOne(targetEntity=”User”, mappedBy=”address”) */ protected $user; /** * @ORMColumn(type=”string”) */ protected $street; /** * @ORMColumn(type=”string”) */ protected $number; }
  125. 125. Samuele Lilli - DonCallisto DON’T CREATE AN EMBEDDED FORM ON PURPOSE
  126. 126. Samuele Lilli - DonCallisto DON’T USE UNMAPPED FIELDS AND FORM EVENTS
  127. 127. Samuele Lilli - DonCallisto USE PROPERTY PATH!
  128. 128. Samuele Lilli - DonCallisto Class UserType extends AbstractType { public function buildForm(FormBuilderInterface $builder, array $options) { // …. $builder ->add(‘street’, TextType::class, [‘property_path’ => ‘address.street’]) ->add(‘number’, TextType::class, [‘property_path’ => ‘address.number’]); } }
  129. 129. QUESTIONS?
  130. 130. Samuele Lilli - DonCallisto THANK YOU

×