From 5295f54b3cf30d7cf11bffe9ca66230c205291cc Mon Sep 17 00:00:00 2001 From: Malcolm Tredinnick Date: Mon, 12 Mar 2007 12:40:03 +0000 Subject: [PATCH] Fixed #1049 -- Documented the need to implement flatten_data() in some cases for custom ChangeManipulator replacements. Thanks, Michael Radziej. git-svn-id: http://code.djangoproject.com/svn/django/trunk@4711 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- docs/forms.txt | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/forms.txt b/docs/forms.txt index 8c40eeb997..f76f6d27ef 100644 --- a/docs/forms.txt +++ b/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 +version. + ``FileField`` and ``ImageField`` special cases ==============================================