GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Catalyst::Plugin::FillInForm(3) User Contributed Perl Documentation Catalyst::Plugin::FillInForm(3)

Catalyst::Plugin::FillInForm - FillInForm for Catalyst

    use Catalyst 'FillInForm'; 
    # that's it, if Catalyst::Plugin::FormValidator is being used

    # OR, manually:

    # in Controller/Root.pm; assume $c->stash->data is seeded elsewhere
    sub end : Private {
      my ( $self, $c ) = @_;
      $c->forward('MyApp::View::TT') unless $c->res->output;
      $c->fillform( $c->stash->data );
      # ....

Fill forms automatically, based on data from a previous HTML form. Typically (but not necessarily) used in conjunction with Catalyst::Plugin::FormValidator. This module automatically inserts data from a previous HTML form into HTML input fields, textarea fields, radio buttons, checkboxes, and select tags. It is an instance of HTML::FillInForm, which itself is a subclass of HTML::Parser, which it uses to parse the HTML and insert the values into the proper form tags.

The usual application is after a user submits an HTML form without filling out a required field, or with errors in fields having specified constraints. FillInForm is used to redisplay the HTML form with all the form elements containing the submitted info. FillInForm can also be used to fill forms with data from any source, e.g. directly from your database.

finalize

Will automatically fill in forms, based on the parameters in "$c->req->parameters", if the last form has missing or invalid fields, and if "Catalyst::Plugin::FormValidator" is being used. "finalize" is called automatically by the Catalyst Engine; the end user will not have to call it directly. (In fact, it should never be called directly by the end user.)

fillform

Fill a form, based on request parameters (the default) or any other specified data hash. You would call this manually if you're getting your data from some source other than the parameters (e.g. if you're seeding an edit form with the results of a database query), or if you're using some other validation system than "Catalyst::Plugin::FormValidator".

    $c->fillform; # defaults to $c->req->parameters

    # OR

    $c->fillform( \%data_hash );

"fillform" must be called after an HTML template has been rendered. A typical way of using it is to place it immediately after your "forward" call to your view class, which might be in a built-in "end" action in your application class.

You can also hand in a hashref of additional params for HTML::FillInForm->fill() if you like. Explicitly providing a \%data_hash is mandatory for this use case.

    $c->fillform( $c->req->parameters, {
       ignore_fields => [ 'pagesrc', 'pagedst' ],
       fill_password => 0,
    } );

This class does not play well with Catalyst's ActionClass('RenderView') so you may want to check your "end" method (in Controller/Root.pm or perhaps MyApp.pm). If it looks like this:

     sub end : ActionClass('RenderView') {}

Then you'll need to change it to something like this:

     sub end : Private {
        my ($self, $c) = @_;
        $c->forward('render');
        $c->fillform($c->req->params) unless $c->res->output;
     }

     sub render : ActionClass('RenderView') { }

Catalyst, Catalyst::Plugin::FormValidator, HTML::FillInForm, Catalyst::Action::RenderView.

Sebastian Riedel, "sri@cpan.org" Marcus Ramberg, "mramberg@cpan.org" Jesse Sheidlower, "jester@panix.com" Jay Hannah, "jay@jays.net"

This program is free software, you can redistribute it and/or modify it under the same terms as Perl itself.
2009-07-11 perl v5.32.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.