X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Manual.git;a=blobdiff_plain;f=lib%2FCatalyst%2FManual%2FTutorial%2F09_AdvancedCRUD%2F09_FormFu.pod;h=0dcc0af076f0bce5e859f65b457a645faad020da;hp=e3b5a0dc3eda053f37a7b3ff7dff08a8fefff5e3;hb=7ce05098c9b1df9078e709e5a724e821a3b3b00d;hpb=16d0d3969b36142004136ddb3e50b8cf499ab7e2 diff --git a/lib/Catalyst/Manual/Tutorial/09_AdvancedCRUD/09_FormFu.pod b/lib/Catalyst/Manual/Tutorial/09_AdvancedCRUD/09_FormFu.pod index e3b5a0d..0dcc0af 100644 --- a/lib/Catalyst/Manual/Tutorial/09_AdvancedCRUD/09_FormFu.pod +++ b/lib/Catalyst/Manual/Tutorial/09_AdvancedCRUD/09_FormFu.pod @@ -58,17 +58,22 @@ L This portion of the tutorial explores L and how it can be used to manage forms, perform validation of form input, as well as save -and restore data to/from the database. This was written using -HTML::FormFu version 0.05001. +and restore data to/from the database. See L for additional form management options other than L. +Source code for the tutorial in included in the F +directory of the Tutorial Virtual machine (one subdirectory per +chapter). There are also instructions for downloading the code in +L. + =head1 HTML::FormFu FORM CREATION This section looks at how L can be used to add additional -functionality to the manually created form from Chapter 4. +functionality to the manually created form from +L. =head2 Inherit From Catalyst::Controller::HTML::FormFu @@ -85,27 +90,30 @@ to use the FormFu base controller class: Don't forget to add: + requires 'HTML::FormFu'; requires 'Catalyst::Controller::HTML::FormFu'; + requires 'HTML::FormFu::Model::DBIC'; to your C. + =head2 Add Action to Display and Save the Form Open C in your editor and add the following method: =head2 formfu_create - + Use HTML::FormFu to create a new book - + =cut - + sub formfu_create :Chained('base') :PathPart('formfu_create') :Args(0) :FormConfig { my ($self, $c) = @_; - + # Get the form that the :FormConfig attribute saved in the stash my $form = $c->stash->{form}; - + # Check if the form has been submitted (vs. displaying the initial # form) and if the data passed validation. "submitted_and_valid" # is shorthand for "$form->submitted && !$form->has_errors" @@ -114,10 +122,9 @@ following method: my $book = $c->model('DB::Book')->new_result({}); # Save the form data for the book $form->model->update($book); - # Set a status message for the user - $c->flash->{status_msg} = 'Book created'; - # Return to the books list - $c->response->redirect($c->uri_for($self->action_for('list'))); + # Set a status message for the user & return to books list + $c->response->redirect($c->uri_for($self->action_for('list'), + {mid => $c->set_status_msg("Book created")})); $c->detach; } else { # Get the authors from the DB @@ -132,7 +139,7 @@ following method: # Add the authors to it $select->options(\@authors); } - + # Set the template $c->stash(template => 'books/formfu_create.tt2'); } @@ -144,7 +151,7 @@ Although C supports any configuration file handled by L, most people tend to use YAML. First create a directory to hold your form configuration files: - mkdir -p root/forms/books + $ mkdir -p root/forms/books Then create the file C and enter the following text: @@ -161,14 +168,14 @@ following text: # This is an optional 'mouse over' title pop-up attributes: title: Enter a book title here - + # Another text field for the numeric rating - type: Text name: rating label: Rating attributes: title: Enter a rating between 1 and 5 here - + # Add a drop-down list for the author selection. Note that we will # dynamically fill in all the authors from the controller but we # could manually set items in the drop-list by adding this YAML code: @@ -178,7 +185,7 @@ following text: - type: Select name: authors label: Author - + # The submit button - type: Submit name: submit @@ -215,11 +222,11 @@ Open C in your editor and enter the following: [% META title = 'Create/Update Book' %] - + [%# Render the HTML::FormFu Form %] [% form %] - -

Return to book list

@@ -252,7 +259,7 @@ form. Fill in the following values: Rating: 4 Author: Comer -Click the Submit button, and you will be returned to the Book List page +Click the "Submit" button, and you will be returned to the Book List page with a "Book created" status message displayed. Also note that this implementation allows you to create books with any @@ -307,7 +314,7 @@ to match: max: 40 # Override the default of 'Invalid input' message: Length must be between 5 and 40 characters - + # Another text field for the numeric rating - type: Text name: rating @@ -331,7 +338,7 @@ to match: min: 1 max: 5 message: "Must be between 1 and 5." - + # Add a select list for the author selection. Note that we will # dynamically fill in all the authors from the controller but we # could manually set items in the select by adding this YAML code: @@ -352,23 +359,23 @@ to match: constraints: # Make sure it's a number - Integer - + # The submit button - type: Submit name: submit value: Submit - + # Global filters and constraints. constraints: - # The user cannot leave any fields blank - - Required - # If not all fields are required, move the Required constraint to the - # fields that are + # The user cannot leave any fields blank + - Required + # If not all fields are required, move the Required constraint to the + # fields that are filter: - # Remove whitespace at both ends - - TrimEdges - # Escape HTML characters for safety - - HTMLEscape + # Remove whitespace at both ends + - TrimEdges + # Escape HTML characters for safety + - HTMLEscape B Copying and pasting YAML from Perl documentation is sometimes tricky. See the L section of @@ -407,6 +414,10 @@ validate the logic and insert feedback as appropriate. Try adding blank spaces at the front or the back of the title and note that it will be removed. +Note that you can update your FormFu YAML forms and the development +server does not need to reload -- the form definition is read from +the YAML file each time a controller action uses it. + =head1 CREATE AND UPDATE/EDIT ACTION @@ -415,28 +426,29 @@ C and add the following method to the bottom: =head2 formfu_edit - + Use HTML::FormFu to update an existing book - + =cut - - sub formfu_edit :Chained('object') :PathPart('formfu_edit') :Args(0) + + sub formfu_edit :Chained('object') :PathPart('formfu_edit') :Args(0) :FormConfig('books/formfu_create.yml') { my ($self, $c) = @_; - + # Get the specified book already saved by the 'object' method my $book = $c->stash->{object}; - + # Make sure we were able to get a book unless ($book) { - $c->flash->{error_msg} = "Invalid book -- Cannot edit"; - $c->response->redirect($c->uri_for($self->action_for('list'))); + # Set an error message for the user & return to books list + $c->response->redirect($c->uri_for($self->action_for('list'), + {mid => $c->set_error_msg("Invalid book -- Cannot edit")})); $c->detach; } - + # Get the form that the :FormConfig attribute saved in the stash my $form = $c->stash->{form}; - + # Check if the form has been submitted (vs. displaying the initial # form) and if the data passed validation. "submitted_and_valid" # is shorthand for "$form->submitted && !$form->has_errors" @@ -444,9 +456,9 @@ bottom: # Save the form data for the book $form->model->update($book); # Set a status message for the user - $c->flash->{status_msg} = 'Book edited'; - # Return to the books list - $c->response->redirect($c->uri_for($self->action_for('list'))); + # Set a status message for the user & return to books list + $c->response->redirect($c->uri_for($self->action_for('list'), + {mid => $c->set_status_msg("Book edited")})); $c->detach; } else { # Get the authors from the DB @@ -463,7 +475,7 @@ bottom: # Populate the form with existing values from DB $form->model->default_values($book); } - + # Set the template $c->stash(template => 'books/formfu_create.tt2'); } @@ -518,13 +530,15 @@ following: ... [% # Add a link to delete a book %] - Delete + Delete [% # Add a link to edit a book %] - Edit + Edit ... -B Only add two lines (the "Add a link to edit a book" comment and +B Only add three lines (the "Add a link to edit a book" comment and the href for C). Make sure you add it below the existing C link. @@ -631,11 +645,8 @@ Kennedy Clark, C Feel free to contact the author for any errors or suggestions, but the best way to report issues is via the CPAN RT Bug system at -. - -The most recent version of the Catalyst Tutorial can be found at -L. +L. -Copyright 2006-2010, Kennedy Clark, under the +Copyright 2006-2011, Kennedy Clark, under the Creative Commons Attribution Share-Alike License Version 3.0 (L).