Document the mapped form type option #1973
Conversation
|
This option seems to be there since 2.1, hence the pull request branch. |
| @@ -0,0 +1,7 @@ | |||
| property_path | |||
There was a problem hiding this comment.
Oops :) - be sure to change this to "mapped"
There was a problem hiding this comment.
Here is what you get when copy/pasting too hastily :P Good catch!
| @@ -12,3 +12,6 @@ name. | |||
|
|
|||
| If you wish the field to be ignored when reading or writing to the object | |||
| you can set the ``property_path`` option to ``false`` | |||
|
|
|||
| .. versionadded:: 2.1 | |||
| Since 2.1, the ``mapped`` option has been added for this use-case | |||
There was a problem hiding this comment.
This is a perfect note, but actually the entire previous sentence needs to be changed as well. Setting property_path to false only works for 2.0, mapped completely replaces that for 2.1.
There was a problem hiding this comment.
Are you dead sure about this? I just checked out origin/2.1, and there is a comment suggesting otherwise right here : https://github.com/symfony/symfony/blob/2.1/src/Symfony/Component/Form/Extension/Core/Type/FormType.php#L187 ...
There was a problem hiding this comment.
Hmm, I think it's just there fore backwards compatibility. So, we should say that using property_path => false to disable mapping is now deprecated and to use mapped instead.
There was a problem hiding this comment.
indeed, it is only kept for BC until 2.3
There was a problem hiding this comment.
@weaverryan : I added something to point that out.
Document the mapped form type option
|
Awesome Grégoire! |
I didn't document the default value, I suppose it is true, because I don't know if there is one or if this option is just ignored when not set (I think it is the latter when looking at FormType.php).