CGI::Panel 0.97

CGI::Panel is a Perl module that allows applications to be built out of simple object-based components. It'll handle the state of your data and objects so you can write a web application just like a desktop app. You can forget about the http requests and responses, whether we're getting or posting, and all that stuff because that is all handled for you leaving to you interact with a simple API.<br /><br />An application is constructed from a set of 'panels', each of which can contain other panels. The panels are managed behind the scenes as persistent objects. See the sample applications for examples of how complex object-based applications can be built from simple encapsulated components. To try the demo app, copy the contents of the 'demo' directory to a cgi-bin directory.<br /><br />CGI::Panel allows you to design the logic of your application in an event-driven manner. That is, you set up your application the way you want it, with special buttons and links that trigger 'events'. The application then sits back and when an event is triggered, the code associated with that event is run. The code that responds to an event goes in the same class as the code that generates the event button or link, making the code more readable and maintainable. If the event code changes the state of any of the panels, the panels will then stay in the new state, until their state is changed again.<br /><br />Each panel is encapsulated not only in terms of the code, but in terms of the form data that is passed through. For example a panel class can be defined which has a textfield called 'name'. Three instances of this panel can then exist simultaneously and each will get the correct value of the 'name' parameter when they read their parameters (see the 'local_params' method).<br /><br />SYNOPSIS<br /><br />A very simple working application consisting of a driver cgi and two panel classes...<br /><br />In simpleapp.cgi:<br /><br /> use SimpleApp;<br /> my $simple_app = obtain SimpleApp;<br /> $simple_app->cycle();<br /><br />In SimpleApp.pm:<br /><br /> package SimpleApp;<br /><br /> use base qw(CGI::Panel);<br /> use Basket;<br /><br /> sub init {<br /> my ($self) = @_;<br /> $self->add_panel('basket1', new Basket); # Add a sub-panel<br /> $self->add_panel('basket2', new Basket); # Add a sub-panel<br /> $self->add_panel('basket3', new Basket); # Add a sub-panel<br /> $self->{count} = 1; # Initialise some persistent data<br /> }<br /><br /> sub _event_add { # Respond to the button click event below<br /> my ($self, $event) = @_;<br /> <br /> $self->{count}++; # Change the persistent data<br /> }<br /><br /> sub display {<br /> my ($self) = @_;<br /> <br /> return<br /> 'This is a very simple app.<br /><br />' .<br /> # Display the persistent data...<br /> "My current count is $self->{count}<br /><br />" .<br /> # Display the sub-panels...<br /> "< table >< tr >" .<br /> "< td >" . $self->panel('basket1')->display . "< /td >" .<br /> "< td >" . $self->panel('basket2')->display . "< /td >" .<br /> "< td >" . $self->panel('basket3')->display . "< /td >" .<br /> "< /tr >< /table >" .<br /> # Display a button that will generate an event...<br /> $self->event_button(label => 'Add 1', name => 'add');<br /> }<br /><br /> 1;<br /><br />In Basket.pm:<br /><br /> package Basket;<br /><br /> use base qw(CGI::Panel);<br /> <br /> sub init {<br /> my ($self) = @_;<br /> <br /> $self->{contents} = [];<br /> }<br /> <br /> sub _event_add { # Respond to the button event in 'display'<br /> my ($self, $event) = @_;<br /><br /> # Get panel's localised parameters<br /> # (Many instances of this panel each get<br /> # their own local parameters)<br /> my %local_params = $self->local_params;<br /> <br /> push @{$self->{contents}}, $local_params{item_name};<br /> }<br /> <br /> sub display {<br /> my ($self) = @_;<br /> <br /> return<br /> '< table bgcolor="#CCCCFF" >' .<br /> join('', (map { "< tr >< td >$_< /td >< /tr >" } @{$self->{contents}})) .<br /> '< tr >' .<br /> # Localised text field<br /> '< td >' . $self->local_textfield({name => 'item_name', size => 10}) . '< /td >' .<br /> # Button that will generate an event (handled by _event_add above)<br /> '< td >' . $self->event_button(label => 'Add', name => 'add') . '< /td >' .<br /> '< /tr >' .<br /> '< /table >';<br /> };<br /> <br /> 1;

Requirements:	No special requirements
Platforms:	*nix, Linux
Keyword:	Application,  Applications,  Basket,  Button,  Cgipanel 0 97,  Event,  Event Add,  Gtquot,  Panel,  Panels,  Parameters,  Persistent,  Quotlt,  Selfgtcontents,  Simple,  Simpleapp,  State,  Subpanel,  Table
Users rating:	0/10