[Jifty-commit] r1379 - in jifty: . trunk/lib/Jifty

[jifty-commit at lists.jifty.org]

Author: nelhage
Date: Wed Jun 28 12:09:08 2006
New Revision: 1379

Modified:
   jifty/   (props changed)
   jifty/trunk/lib/Jifty/Action.pm
   jifty/trunk/lib/Jifty/Web/Form/Field.pm

Log:
 r13212 at phanatique:  nelhage | 2006-06-27 16:08:01 +0200
 Documenting some more argument keys for Action


Modified: jifty/trunk/lib/Jifty/Action.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Action.pm	(original)
+++ jifty/trunk/lib/Jifty/Action.pm	Wed Jun 28 12:09:08 2006
@@ -139,10 +139,18 @@
 See L<Jifty::Web::Form::Field> for the list of possible keys that each
 argument can have.
 
-In addition to the list there, you may use this additional key:
+In addition to the list there, you may use these additional keys:
 
 =over
 
+=item constructor
+
+A boolean which, if set, indicates that the argument B<must> be
+present in the C<arguments> passed to create the action, rather than
+being expected to be set later.
+
+Defaults to false.
+
 =item ajax_canonicalizes
 
 This key takes a boolean value that determines if the value displayed in
@@ -167,6 +175,9 @@
 If the result of the action is currently a success (validation did not
 fail), C<run> calls L</take_action>, and finally L</cleanup>.
 
+If you're writing your own actions, you probably want to override
+C<take_action> instead.
+
 =cut
 
 sub run {

Modified: jifty/trunk/lib/Jifty/Web/Form/Field.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Web/Form/Field.pm	(original)
+++ jifty/trunk/lib/Jifty/Web/Form/Field.pm	Wed Jun 28 12:09:08 2006
@@ -134,6 +134,28 @@
 
 Gets or sets the value for the form field that was submitted in the last action.
 
+=head2 mandatory [VALUE]
+
+A boolean indicating that the argument B<must> be present when the
+user submits the form.
+
+=back
+
+=head2 ajax_validates [VALUE]
+
+A boolean value indicating if user input into an HTML form field for
+this argument should be L<validated|Jifty::Manual::Glossary/validate>
+via L<AJAX|Jifty::Manual::Glossary/AJAX> as the user fills out the
+form, instead of waiting until submit. Arguments will B<always> be
+validated before the action is run, whether or not they also
+C<ajax_validate>.
+
+=back
+
+=head2
+
+=back
+
 =cut
 
 =head2 id