8000 [Form] Document usage of adders and removers · Issue #1057 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

[Form] Document usage of adders and removers #1057

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
webmozart opened this issue Feb 2, 2012 · 5 comments
Closed

[Form] Document usage of adders and removers #1057

webmozart opened this issue Feb 2, 2012 · 5 comments
Labels
actionable Clear and specific issues ready for anyone to take them. Form
Milestone
2.1

Comments

@webmozart
Copy link
Contributor

As of symfony/symfony#3239 the "collection" and "choice" types (with multiple=true) as well as subtypes (such as "entity") will try to discover an adder and a remover method in your model if "by_reference" is set to false.

Example form:

$form = $this->createFormBuilder($article)
    ->add('tags', null, array('by_reference' => false))
    ->getForm();

The underlying article class is expected to look like this:

class Article
{
    public function addTag($tag) { ... }
    public function removeTag($tag) { ... }
    public function getTags($tag) { ... }
}

If adder and remover are not found, the form behaves differently depending on whether getTags returns an object or an array.

  1. If it returns an object (collection), the object is modified by reference and not written back
  2. If it returns an array, the array is modified and written back using setTags

You can force a write-back in case (1) by setting the field option "by_reference" to false. Note that in this case, adders and removers won't be used even if present! Instead, the expected object signature is

class Article
{
    public function setTags($tags) { ... }
    public function getTags($tag) { ... }
}
@keymaster
Copy link

Also, the adder/remover prefixes are configurable.
symfony/symfony@9b0245b

@webmozart
Copy link
Contributor Author

@keymaster This has changed again. See #1227

@webmozart webmozart mentioned this issue Apr 12, 2012
Closed
@weaverryan weaverryan mentioned this issue Jan 20, 2013
Closed
@wouterj wouterj mentioned this issue Jan 31, 2013
Closed
@wouterj
Copy link
Member
wouterj commented Mar 21, 2013

This should get changed in cookbook/form/form_collections

@weaverryan weaverryan mentioned this issue Mar 29, 2013
Closed
@weaverryan
Copy link
Member

@wouterj I agree that we should add the addXxx and removeXxx details as needed to the form_collections chapter. We then might also consider a short, standalone cookbook article with an expanded version of what we have here. The advantage is that it helps keep form_collections short while letting us talk about this in good detail. We can also link to it from other places.

@weaverryan weaverryan mentioned this issue Mar 30, 2013
Merged
@wouterj wouterj mentioned this issue Mar 30, 2013
Merged
@wouterj
Copy link
Member
wouterj commented Jun 5, 2013

Closing this as #2434 is merged

@wouterj wouterj closed this as completed Jun 5, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
actionable Clear and specific issues ready for anyone to take them. Form
Projects
None yet
Milestone
2.1
Development

No branches or pull requests
4 participants
@weaverryan @webmozart @keymaster @wouterj
0