webgui/lib/WebGUI/Form.pm

151 lines
3.4 KiB
Perl

package WebGUI::Form;
=head1 LEGAL
-------------------------------------------------------------------
WebGUI is Copyright 2001-2007 Plain Black Corporation.
-------------------------------------------------------------------
Please read the legal notices (docs/legal.txt) and the license
(docs/license.txt) that came with this distribution before using
this software.
-------------------------------------------------------------------
http://www.plainblack.com info@plainblack.com
-------------------------------------------------------------------
=cut
use strict;
use Tie::IxHash;
use WebGUI::Asset;
use WebGUI::Asset::RichEdit;
use WebGUI::Asset::Template;
use WebGUI::International;
use WebGUI::Utility;
=head1 NAME
Package WebGUI::Form
=head1 DESCRIPTION
This is a convenience package which provides a simple interface to use all of the form controls without having to load each one seperately, create objects, and call methods.
=head1 SYNOPSIS
use WebGUI::Form;
$html = WebGUI::Form::formFooter($self->session,);
$html = WebGUI::Form::formHeader($self->session,);
$html = WebGUI::Form::anyFieldType($self->session,%properties);
Example:
$html = WebGUI::Form::text($self->session,%properties);
=head1 METHODS
These functions are available from this package:
=cut
#-------------------------------------------------------------------
=head2 AUTOLOAD ( )
Dynamically creates functions on the fly for all the different form control types.
=cut
sub AUTOLOAD {
our $AUTOLOAD;
my $name = ucfirst((split /::/, $AUTOLOAD)[-1]);
my $session = shift;
my @params = @_;
my $cmd = "use WebGUI::Form::".$name;
eval ($cmd);
if ($@) {
$session->errorHandler->error("Couldn't compile form control: ".$name.". Root cause: ".$@);
return;
}
my $class = "WebGUI::Form::".$name;
return $class->new($session,@params)->toHtml;
}
#-------------------------------------------------------------------
=head2 formFooter ( session )
Returns a form footer.
=head3 session
A reference to the current session.
=cut
sub formFooter {
return "</div></form>\n\n";
}
#-------------------------------------------------------------------
=head2 formHeader ( session, hashRef )
Returns a form header.
=head3 session
A reference to the current session.
=head3 hashRef
A hash reference that contains one or more of the following parameters.
=head4 action
The form action. Defaults to the current page.
=head4 method
The form method. Defaults to "post".
=head4 enctype
The form enctype. Defaults to "multipart/form-data".
=head4 extras
If you want to add anything special to the form header like javascript actions or stylesheet info, then use this.
=cut
sub formHeader {
my $session = shift;
my $params = shift;
my $action = $params->{action} || $session->url->page();
my $hidden;
if ($action =~ /\?/) {
my ($path,$query) = split(/\?/,$action);
$action = $path;
my @params = split(/\;/,$query);
foreach my $param (@params) {
$param =~ s/amp;(.*)/$1/;
my ($name,$value) = split(/\=/,$param);
$hidden .= hidden($session,{name=>$name,value=>$value});
}
}
my $method = $params->{method} || "post";
my $enctype = $params->{enctype} || "multipart/form-data";
return '<form action="'.$action.'" enctype="'.$enctype.'" method="'.$method.'" '.$params->{extras}.'><div class="formContents">'.$hidden;
}
1;