CGI::Ex 2.16

[chaz/p5-CGI-Ex] / lib / CGI / Ex / App.pod

diff --git a/lib/CGI/Ex/App.pod b/lib/CGI/Ex/App.pod
index 6fe97464e0e828e7d241fff509c46dcfe814ffd8..3b93a78383b9d490976b7f1e6456d9442c5c2cfe 100644 (file)
--- a/lib/CGI/Ex/App.pod
+++ b/lib/CGI/Ex/App.pod
@@ -132,8 +132,10 @@ How about a form with validation (inluding javascript validation)...
 There are infinite possibilities.  There is a longer "SYNOPSIS" after
 the process flow discussion and more examples near the end of this
 document.  It is interesting to note that there have been no databases
 There are infinite possibilities.  There is a longer "SYNOPSIS" after
 the process flow discussion and more examples near the end of this
 document.  It is interesting to note that there have been no databases

-so far.  CGI::Ex::App is Controller/Viewer that is somewhat Model
-agnostic.
+so far.  It is very, very difficult to find a single database
+abstraction that fits every model.  CGI::Ex::App is Controller/Viewer
+that is somewhat Model agnostic and doesn't come with any default
+database abstraction.

 
 =head1 DESCRIPTION
 
 
 =head1 DESCRIPTION
 


@@ -245,16 +247,16 @@ during the run_step hook.
 
     run_step {
         ->pre_step (hook)
 
     run_step {
         ->pre_step (hook)

-            # exits nav_loop if true
+            # skips this step if true and exit nav_loop

 
         ->skip (hook)
 
         ->skip (hook)

-            # skips this step if true (stays in nav_loop)
+            # skips this step if true and stays in nav_loop

 
         ->prepare (hook - defaults to true)
 
         ->info_complete (hook - ran if prepare was true)
             ->ready_validate (hook)
 
         ->prepare (hook - defaults to true)
 
         ->info_complete (hook - ran if prepare was true)
             ->ready_validate (hook)

-            return false if ! ready_validate
+                # returns false from info_complete if ! ready_validate

             ->validate (hook - uses CGI::Ex::Validate to validate form info)
                 ->hash_validation (hook)
                    ->file_val (hook)
             ->validate (hook - uses CGI::Ex::Validate to validate form info)
                 ->hash_validation (hook)
                    ->file_val (hook)


@@ -263,7 +265,7 @@ during the run_step hook.
                        ->name_module
                        ->name_step
                        ->ext_val
                        ->name_module
                        ->name_step
                        ->ext_val

-            returns true if validate is true or if nothing to validate
+            # returns true if validate is true or if nothing to validate

 
         ->finalize (hook - defaults to true - ran if prepare and info_complete were true)
 
 
         ->finalize (hook - defaults to true - ran if prepare and info_complete were true)
 


@@ -1113,8 +1115,8 @@ The following items will be cleared:
     path
     path_i
     history
     path
     path_i
     history

-    __morph_lineage_start_index
-    __morph_lineage
+    _morph_lineage_start_index
+    _morph_lineage

     hash_errors
     hash_fill
     hash_swap
     hash_errors
     hash_fill
     hash_swap


@@ -1202,6 +1204,11 @@ called is "view".
             "    view - post_print - post_print - 0.00003 - 0"
     ];
 
             "    view - post_print - post_print - 0.00003 - 0"
     ];
 

+=item error_step (method)
+
+Defaults to "__error".  The name of a step to run should a dying error
+be caught by the default handle_error method.  See the handle_error method.
+

 =item exit_nav_loop (method)
 
 This method should not normally used but there is no problem with
 =item exit_nav_loop (method)
 
 This method should not normally used but there is no problem with


@@ -1235,40 +1242,6 @@ then the file "foo.val" will be searched for.
 
 See the section on FINDING TEMPLATES for further discussion.
 
 
 See the section on FINDING TEMPLATES for further discussion.
 

-=item first_step (method)
-
-Returns the first step of the path.  Note that first_step may not be the same
-thing as default_step if the path was overridden.
-
-=item form (method)
-
-Returns a hashref of the items passed to the CGI.  Returns
-$self->{form} which defaults to CGI::Ex::get_form.
-
-=item handle_error (method)
-
-If anything dies during execution, handle_error will be called with
-the error that had happened.  Default action is to die with that error.
-
-=item history (method)
-
-Returns an arrayref which contains trace history of which hooks of
-which steps were ran.  Useful for seeing what happened.  In general -
-each line of the history will show the current step, the hook
-requested, and which hook was actually called.
-
-The dump_history method shows a short condensed version of this
-history which makes it easier to see what path was followed.
-
-In general, the arrayref is free for anything to push onto which will
-help in tracking other occurrences in the program as well.
-
-=item init (method)
-
-Called by the default new method.  Allows for any object
-initilizations that may need to take place.  Default action does
-nothing.
-

 =item fill_args (hook)
 
 Returns a hashref of args that will be passed to the CGI::Ex::Fill::fill.
 =item fill_args (hook)
 
 Returns a hashref of args that will be passed to the CGI::Ex::Fill::fill.


@@ -1324,7 +1297,7 @@ The file should be readable by CGI::Ex::Validate::get_validation.
 
 This hook is only necessary if the hash_validation hook has not been
 overridden.
 
 This hook is only necessary if the hash_validation hook has not been
 overridden.

-
+5B

 This method an also return a hashref containing the validation - but
 then you may have wanted to override the hash_validation hook.
 
 This method an also return a hashref containing the validation - but
 then you may have wanted to override the hash_validation hook.
 


@@ -1368,12 +1341,22 @@ override the base package (it is still OK to use the full method name
 
 See the run_hook method and the morph method for more details.
 
 
 See the run_hook method and the morph method for more details.
 

+=item first_step (method)
+
+Returns the first step of the path.  Note that first_step may not be the same
+thing as default_step if the path was overridden.
+

 =item forbidden_step (method)
 
 Defaults to "__forbidden".  The name of a step to run should the current
 step name be invalid, or if a step found by the default path method
 is invalid.  See the path method.
 
 =item forbidden_step (method)
 
 Defaults to "__forbidden".  The name of a step to run should the current
 step name be invalid, or if a step found by the default path method
 is invalid.  See the path method.
 

+=item form (method)
+
+Returns a hashref of the items passed to the CGI.  Returns
+$self->{form} which defaults to CGI::Ex::get_form.
+

 =item form_name (hook)
 
 Return the name of the form to attach the js validation to.  Used by
 =item form_name (hook)
 
 Return the name of the form to attach the js validation to.  Used by


@@ -1433,6 +1416,12 @@ Full customization of the login process and the login template can
 be done via the auth_args hash.  See the auth_args method and
 CGI::Ex::Auth perldoc for more information.
 
 be done via the auth_args hash.  See the auth_args method and
 CGI::Ex::Auth perldoc for more information.
 

+=item handle_error (method)
+
+If anything dies during execution, handle_error will be called with
+the error that had happened.  Default action is to try running the
+step returned by the error_step method.
+

 =item hash_base (hook)
 
 A hash of base items to be merged with hash_form - such as pulldown
 =item hash_base (hook)
 
 A hash of base items to be merged with hash_form - such as pulldown


@@ -1525,6 +1514,19 @@ pass it to CGI::Ex::Validate::get_validation.  If no file_val is
 returned or if the get_validation fails, an empty hash will be returned.
 Validation is implemented by ->vob which loads a CGI::Ex::Validate object.
 
 returned or if the get_validation fails, an empty hash will be returned.
 Validation is implemented by ->vob which loads a CGI::Ex::Validate object.
 

+=item history (method)
+
+Returns an arrayref which contains trace history of which hooks of
+which steps were ran.  Useful for seeing what happened.  In general -
+each line of the history will show the current step, the hook
+requested, and which hook was actually called.
+
+The dump_history method shows a short condensed version of this
+history which makes it easier to see what path was followed.
+
+In general, the arrayref is free for anything to push onto which will
+help in tracking other occurrences in the program as well.
+

 =item info_complete (hook)
 
 Calls the ready_validate hook to see if data is ready to validate.  If
 =item info_complete (hook)
 
 Calls the ready_validate hook to see if data is ready to validate.  If


@@ -1532,6 +1534,12 @@ so it calls the validate hook to validate the data.  Should make
 sure the data is ready and valid.  Will not be run unless
 prepare returns true (default).
 
 sure the data is ready and valid.  Will not be run unless
 prepare returns true (default).
 

+=item init (method)
+
+Called by the default new method.  Allows for any object
+initilizations that may need to take place.  Default action does
+nothing.
+

 =item insert_path (method)
 
 Arguments are the steps to insert.  Can be called any time.  Inserts
 =item insert_path (method)
 
 Arguments are the steps to insert.  Can be called any time.  Inserts


@@ -3079,12 +3087,12 @@ the original versions.
 
     Krassimir Berov - feedback and some warnings issues with POD examples.
 
 
     Krassimir Berov - feedback and some warnings issues with POD examples.
 

-=head1 AUTHOR
-
-Paul Seamons <paul at seamons dot com>
-

 =head1 LICENSE
 
 This module may be distributed under the same terms as Perl itself.
 
 =head1 LICENSE
 
 This module may be distributed under the same terms as Perl itself.
 

+=head1 AUTHOR
+
+Paul Seamons <perl at seamons dot com>
+

 =cut
 =cut