Browse files

Fixed #1049 -- Documented the need to implement flatten_data() in som…

…e cases for custom

ChangeManipulator replacements. Thanks, Michael Radziej.

git-svn-id: bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
1 parent db03c7f commit 5295f54b3cf30d7cf11bffe9ca66230c205291cc @malcolmt malcolmt committed Mar 12, 2007
Showing with 21 additions and 0 deletions.
  1. +21 −0 docs/forms.txt
@@ -417,6 +417,27 @@ Here's a simple function that might drive the above form::
form = forms.FormWrapper(manipulator, new_data, errors)
return render_to_response('contact_form.html', {'form': form})
+Implementing ``flatten_data`` for custom manipulators
+It is possible (although rarely needed) to replace the default automatically
+created manipulators on a model with your own custom manipulators. If you do
+this and you are intending to use those models in generic views, you should
+also define a ``flatten_data`` method in any ``ChangeManipulator`` replacement.
+This should act like the default ``flatten_data`` and return a dictionary
+mapping field names to their values, like so::
+ def flatten_data(self):
+ obj = self.original_object
+ return dict(
+ from = obj.from,
+ subject = obj.subject,
+ ...
+ )
+In this way, your new change manipulator will act exactly like the default
``FileField`` and ``ImageField`` special cases

0 comments on commit 5295f54

Please sign in to comment.