Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
merged branch bschussek/issue1540 (PR #3239)
Commits ------- 9b0245b [Form] Made prefix of adder and remover method configurable. Adders and removers are not called if "by_reference" is disabled. 49d1464 [Form] Implemented MergeCollectionListener which calls addXxx() and removeXxx() in your model if found 7837f50 [Form] Added FormUtil::singularify() Discussion ---------- [Form] Forms now call addXxx() and removeXxx() in your model Bug fix: no Feature addition: yes Backwards compatibility break: no Symfony2 tests pass: yes Fixes the following tickets: #1540 Todo: adapt documentation  Adds functionality for calling `addXxx` and `removeXxx` method in your model. All types returning a collection of values are affected: "collection", "choice" (with multiple selection) and "entity" (with multiple selection). Example: class Article { public function addTag($tag) { ... } public function removeTag($tag) { ... } public function getTags($tag) { ... } } And the controller: $form = $this->createFormBuilder($article) ->add('tags') ->getForm(); Upon modifying the form, addTag() and removeTag() are now called appropiately. --------------------------------------------------------------------------- by stof at 2012-02-01T18:23:49Z Really great --------------------------------------------------------------------------- by vicb at 2012-02-01T18:24:04Z Great !! Two suggestions: * make "add" and "remove" configurable, * introduce a base class for the remove listeners with (final?) `::getSubscribedEvents()` and `::getEventPriorities()` --------------------------------------------------------------------------- by haswalt at 2012-02-01T18:57:46Z +1 this --------------------------------------------------------------------------- by daFish at 2012-02-01T19:54:46Z +1 --------------------------------------------------------------------------- by michelsalib at 2012-02-01T20:55:37Z Can wait to have it! It will save lots of time trying to solve WTF effects and making workarounds. --------------------------------------------------------------------------- by bschussek at 2012-02-02T09:37:12Z @vicb: Your first point is done. The second, I don't understand. --------------------------------------------------------------------------- by stof at 2012-02-02T09:40:50Z @bschussek your branch conflicts with master according to github --------------------------------------------------------------------------- by vicb at 2012-02-02T09:52:40Z @bschussek my point is that I can stand hard-coded priorities which are error prone. A better solution might be to introduce constants (in `FormEvents` / `FormEventPriorities` ?) with meaningful names. --------------------------------------------------------------------------- by bschussek at 2012-02-02T10:21:52Z @stof Rebased @vicb I know, but who is responsible for managing priorities? There is no central entitty that can do this. (btw this is a general problem of the priority system of the EventDispatcher) @fabpot Ready to merge. --------------------------------------------------------------------------- by vicb at 2012-02-02T10:23:28Z @bschussek doesn't each form has is own dispatcher so there is no need for a global registry here, something local to the form could be good enough.
- Loading branch information
Showing
15 changed files
with
1,093 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
179 changes: 179 additions & 0 deletions
179
src/Symfony/Component/Form/Extension/Core/EventListener/MergeCollectionListener.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\Form\Extension\Core\EventListener; | ||
|
|
||
| use Symfony\Component\Form\Util\FormUtil; | ||
|
|
||
| use Symfony\Component\Form\FormEvents; | ||
| use Symfony\Component\Form\Event\FilterDataEvent; | ||
| use Symfony\Component\EventDispatcher\EventSubscriberInterface; | ||
| use Symfony\Component\Form\Exception\UnexpectedTypeException; | ||
|
|
||
| /** | ||
| * @author Bernhard Schussek <bschussek@gmail.com> | ||
| */ | ||
| class MergeCollectionListener implements EventSubscriberInterface | ||
| { | ||
| /** | ||
| * Whether elements may be added to the collection | ||
| * @var Boolean | ||
| */ | ||
| private $allowAdd; | ||
|
|
||
| /** | ||
| * Whether elements may be removed from the collection | ||
| * @var Boolean | ||
| */ | ||
| private $allowDelete; | ||
|
|
||
| /** | ||
| * Whether to search for and use adder and remover methods | ||
| * @var Boolean | ||
| */ | ||
| private $useAccessors; | ||
|
|
||
| /** | ||
| * The prefix of the adder method to look for | ||
| * @var string | ||
| */ | ||
| private $adderPrefix; | ||
|
|
||
| /** | ||
| * The prefix of the remover method to look for | ||
| * @var string | ||
| */ | ||
| private $removerPrefix; | ||
|
|
||
| public function __construct($allowAdd = false, $allowDelete = false, $useAccessors = true, $adderPrefix = 'add', $removerPrefix = 'remove') | ||
| { | ||
| $this->allowAdd = $allowAdd; | ||
| $this->allowDelete = $allowDelete; | ||
| $this->useAccessors = $useAccessors; | ||
| $this->adderPrefix = $adderPrefix; | ||
| $this->removerPrefix = $removerPrefix; | ||
| } | ||
|
|
||
| static public function getSubscribedEvents() | ||
| { | ||
| return array(FormEvents::BIND_NORM_DATA => 'onBindNormData'); | ||
| } | ||
|
|
||
| public function onBindNormData(FilterDataEvent $event) | ||
| { | ||
| $originalData = $event->getForm()->getData(); | ||
| $form = $event->getForm(); | ||
| $data = $event->getData(); | ||
| $parentData = $form->hasParent() ? $form->getParent()->getData() : null; | ||
| $adder = null; | ||
| $remover = null; | ||
|
|
||
| if (null === $data) { | ||
| $data = array(); | ||
| } | ||
|
|
||
| if (!is_array($data) && !($data instanceof \Traversable && $data instanceof \ArrayAccess)) { | ||
| throw new UnexpectedTypeException($data, 'array or (\Traversable and \ArrayAccess)'); | ||
| } | ||
|
|
||
| if (null !== $originalData && !is_array($originalData) && !($originalData instanceof \Traversable && $originalData instanceof \ArrayAccess)) { | ||
| throw new UnexpectedTypeException($originalData, 'array or (\Traversable and \ArrayAccess)'); | ||
| } | ||
|
|
||
| // Check if the parent has matching methods to add/remove items | ||
| if ($this->useAccessors && is_object($parentData)) { | ||
| $plural = ucfirst($form->getName()); | ||
| $singulars = (array) FormUtil::singularify($plural); | ||
| $reflClass = new \ReflectionClass($parentData); | ||
|
|
||
| foreach ($singulars as $singular) { | ||
| $adderName = $this->adderPrefix . $singular; | ||
| $removerName = $this->removerPrefix . $singular; | ||
|
|
||
| if ($reflClass->hasMethod($adderName) && $reflClass->hasMethod($removerName)) { | ||
| $adder = $reflClass->getMethod($adderName); | ||
| $remover = $reflClass->getMethod($removerName); | ||
|
|
||
| if ($adder->isPublic() && $adder->getNumberOfRequiredParameters() === 1 | ||
| && $remover->isPublic() && $remover->getNumberOfRequiredParameters() === 1) { | ||
|
|
||
| // We found a public, one-parameter add and remove method | ||
| break; | ||
| } | ||
|
|
||
| // False alert | ||
| $adder = null; | ||
| $remover = null; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Check which items are in $data that are not in $originalData and | ||
| // vice versa | ||
| $itemsToDelete = array(); | ||
| $itemsToAdd = is_object($data) ? clone $data : $data; | ||
|
|
||
| if ($originalData) { | ||
| foreach ($originalData as $originalKey => $originalItem) { | ||
| foreach ($data as $key => $item) { | ||
| if ($item === $originalItem) { | ||
| // Item found, next original item | ||
| unset($itemsToAdd[$key]); | ||
| continue 2; | ||
| } | ||
| } | ||
|
|
||
| // Item not found, remember for deletion | ||
| $itemsToDelete[$originalKey] = $originalItem; | ||
| } | ||
| } | ||
|
|
||
| if ($adder && $remover) { | ||
| // If methods to add and to remove exist, call them now, if allowed | ||
| if ($this->allowDelete) { | ||
| foreach ($itemsToDelete as $item) { | ||
| $remover->invoke($parentData, $item); | ||
| } | ||
| } | ||
|
|
||
| if ($this->allowAdd) { | ||
| foreach ($itemsToAdd as $item) { | ||
| $adder->invoke($parentData, $item); | ||
| } | ||
| } | ||
| } elseif (!$originalData) { | ||
| // No original data was set. Set it if allowed | ||
| if ($this->allowAdd) { | ||
| $originalData = $data; | ||
| } | ||
| } else { | ||
| // Original data is an array-like structure | ||
| // Add and remove items in the original variable | ||
| if ($this->allowDelete) { | ||
| foreach ($itemsToDelete as $key => $item) { | ||
| unset($originalData[$key]); | ||
| } | ||
| } | ||
|
|
||
| if ($this->allowAdd) { | ||
| foreach ($itemsToAdd as $key => $item) { | ||
| if (!isset($originalData[$key])) { | ||
| $originalData[$key] = $item; | ||
| } else { | ||
| $originalData[] = $item; | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| $event->setData($originalData); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.