=head1 SYNOPSIS
-See L<Maypole::Application>.
+The canonical example used in the Maypole documentation is the beer database:
+
+ package BeerDB;
+ use strict;
+ use warnings;
+
+ # choose a frontend, initialise the config object, and load a plugin
+ use Maypole::Application qw/Relationship/;
+
+ # get the empty config object created by Maypole::Application
+ my $config = __PACKAGE__->config;
+
+ # basic settings
+ $config->uri_base("http://localhost/beerdb");
+ $config->template_root("/path/to/templates");
+ $config->rows_per_page(10);
+ $config->display_tables([qw/beer brewery pub style/]);
+
+ # table relationships
+ $config->relationships([
+ "a brewery produces beers",
+ "a style defines beers",
+ "a pub has beers on handpumps",
+ ]);
+
+ # validation
+ BeerDB::Brewery->untaint_columns( printable => [qw/name notes url/] );
+ BeerDB::Pub->untaint_columns( printable => [qw/name notes url/] );
+ BeerDB::Style->untaint_columns( printable => [qw/name notes/] );
+ BeerDB::Beer->untaint_columns(
+ printable => [qw/abv name price notes/],
+ integer => [qw/style brewery score/],
+ date => [ qw/date/],
+ );
+
+ # set everything up
+ __PACKAGE__->setup("dbi:SQLite:t/beerdb.db");
+
+ 1;
=head1 DESCRIPTION
This needs to first use L<Maypole::Application> which will make your package
inherit from the appropriate platform driver such as C<Apache::MVC> or
-C<CGI::Maypole>. Then, the driver calls C<setup>. This sets up the model classes and
-configures your application. The default model class for Maypole uses
+C<CGI::Maypole>. Then, the driver calls C<setup>. This sets up the model classes
+and configures your application. The default model class for Maypole uses
L<Class::DBI> to map a database to classes, but this can be changed by altering
configuration (B<before> calling setup.)
__PACKAGE__->mk_accessors(
qw( params query objects model_class template_args output path
args action template error document_encoding content_type table
- headers_in headers_out stash session)
+ headers_in headers_out stash session user)
);
__PACKAGE__->config( Maypole::Config->new() );
As a framework, Maypole provides a number of B<hooks> - methods that are
intended to be overridden. Some of these methods come with useful default
-behaviour, others do nothing by default. Likely hooks include:
+behaviour, others do nothing by default. Hooks include:
Class methods
-------------
$self->get_request($req);
$self->parse_location;
- # hook useful for declining static requests e.g. images
+ # hook useful for declining static requests e.g. images, or perhaps for
+ # sanitizing request parameters
my $status = $self->start_request_hook;
return $status unless $status == Maypole::Constants::OK();
$self->session($self->get_session);
+ $self->user($self->get_user);
$status = $self->handler_guts;
=item get_session
+Called immediately after C<start_request_hook()>.
+
+This method should return a session, which will be stored in the request's
+C<session> attribute.
+
The default method is empty.
=cut
sub get_session { }
+=item get_user
+
+Called immediately after C<get_session>.
+
+This method should return a user, which will be stored in the request's C<user>
+attribute.
+
+The default method is empty.
+
+=cut
+
+sub get_user {}
+
=item call_authenticate
This method first checks if the relevant model class
return $self->exception($error);
}
+
=item exception
This method is called if any exceptions are raised during the authentication or
$self->$_(undef) for qw/action table args/;
$self->preprocess_path;
-
$self->path || $self->path('frontpage');
-
+
my @pi = grep {length} split '/', $self->path;
-
+
+
$self->table || $self->table(shift @pi);
$self->action || $self->action( shift @pi or 'index' );
$self->args || $self->args(\@pi);
| | |
|-----+ init | |
||<---+ | |
- || | new | view_object: e.g
+ || | new | view_object: e.g.
||---------------------------------------------> Maypole::View::TT
| | | |
| | | |
| ||-----+ get_session | | |
| |||<---+ | | |
| || | | |
+ | ||-----+ get_user | | |
+ | |||<---+ | | |
+ | || | | |
| ||-----+ handler_guts | | |
| |||<---+ | | |
| ||| class_of($table) | | |
| ||| | | |
| |||-----+ additional_data | | |
| ||||<---+ | | |
- | ||| process | | fetch_objects
- | |||--------------------------------->||-----+ |
+ | ||| process | | |
+ | |||--------------------------------->|| fetch_objects
+ | ||| | ||-----+ |
| ||| | |||<---+ |
| ||| | || |
| ||| | || $action
| ||| | ||-----+ |
- | ||| | |||<---+ |
- | ||| | | |
+ | ||| | |||<---+ |
| ||| process | | |
| |||------------------------------------------->|| template
| ||| | | ||-----+
=head1 SEE ALSO
-There's more documentation, examples, and a information on our mailing lists
+There's more documentation, examples, and information on our mailing lists
at the Maypole web site:
L<http://maypole.perl.org/>
=head1 AUTHOR
-Maypole is currently maintained by Aaron Trevena
+Maypole is currently maintained by Aaron Trevena, David Baird, Dave Howorth and
+Peter Speltz.
=head1 AUTHOR EMERITUS
Simon Cozens, C<simon#cpan.org>
+Simon Flack maintained Maypole from 2.05 to 2.09
+
Sebastian Riedel, C<sri#oook.de> maintained Maypole from 1.99_01 to 2.04
=head1 THANKS TO
projects / maypole.git / blobdiff