package Maypole;
use base qw(Class::Accessor::Fast Class::Data::Inheritable);
-use attributes ();
use UNIVERSAL::require;
use strict;
use warnings;
use Maypole::Config;
-our $VERSION = '2.0';
+use Maypole::Constants;
+use Maypole::Headers;
+
+our $VERSION = '2.05';
+
__PACKAGE__->mk_classdata($_) for qw( config init_done view_object );
__PACKAGE__->mk_accessors(
qw( ar params query objects model_class template_args output path
- args action template error document_encoding content_type table)
+ args action template error document_encoding content_type table
+ headers_in headers_out )
);
__PACKAGE__->config( Maypole::Config->new() );
__PACKAGE__->init_done(0);
-use Maypole::Constants;
sub debug { 0 }
$calling_class = ref $calling_class if ref $calling_class;
{
no strict 'refs';
+ no warnings 'redefine';
# Naughty.
*{ $calling_class . "::handler" } =
$config->view->require;
die "Couldn't load the view class " . $config->view . ": $@" if $@;
$config->display_tables
- || $config->display_tables( [ $class->config->tables ] );
+ || $config->display_tables( $class->config->tables );
$class->view_object( $class->config->view->new );
$class->init_done(1);
# See Maypole::Workflow before trying to understand this.
my ( $class, $req ) = @_;
$class->init unless $class->init_done;
- my $r = bless { config => $class->config }, $class;
+ my $r = bless { template_args => {}, config => $class->config }, $class;
+ $r->headers_out(Maypole::Headers->new);
$r->get_request($req);
$r->parse_location();
my $status = $r->handler_guts();
sub handler_guts {
my $r = shift;
$r->model_class( $r->config->model->class_of( $r, $r->{table} ) );
+
my $applicable = $r->is_applicable;
unless ( $applicable == OK ) {
$config->ok_tables || $config->ok_tables( $config->display_tables );
$config->ok_tables( { map { $_ => 1 } @{ $config->ok_tables } } )
if ref $config->ok_tables eq "ARRAY";
- warn "We don't have that table ($self->{table})"
+ warn "We don't have that table ($self->{table}).\n"
+ . "Available tables are: "
+ . join( ",", @{ $config->{display_tables} } )
if $self->debug
- and not $config->ok_tables->{ $self->{table} };
+ and not $config->ok_tables->{ $self->{table} }
+ and $self->{action};
return DECLINED() unless exists $config->ok_tables->{ $self->{table} };
- # Does the action method exist?
- my $cv = $self->model_class->can( $self->{action} );
- warn "We don't have that action ($self->{action})"
- if $self->debug and not $cv;
- return DECLINED() unless $cv;
-
- # Is it exported?
- $self->{method_attribs} = join " ", attributes::get($cv);
- do {
- warn "$self->{action} not exported" if $self->debug;
- return DECLINED();
- } unless $self->{method_attribs} =~ /\bExported\b/i;
+ # Is it public?
+ return DECLINED unless $self->model_class->is_public( $self->{action} );
return OK();
}
shift @pi while @pi and !$pi[0];
$self->{table} = shift @pi;
$self->{action} = shift @pi;
+ $self->{action} = "index" unless $self->{action};
$self->{args} = \@pi;
}
=head1 DESCRIPTION
This documents the Maypole request object. For user documentation, see
-L<Maypole::Tutorial>.
+L<Maypole::Manual>.
=head2 CLASS METHODS
=head3 setup
- My::App->setup();
+ My::App->setup($data_source, $user, $password, \%attr);
- Initialise the maypole application and model classes. Your
- application should
- call this after setting configuration via L<"config">
+Initialise the maypole application and model classes. Your application should
+call this after setting configuration via L<"config">
=head3 init
sub My::App::debug {1}
- Returns the debugging flag. Override this in your application class
- to
- enable/disable debugging.
+Returns the debugging flag. Override this in your application class to
+enable/disable debugging.
=head2 INSTANCE METHODS
have been
removed
+=head3 headers_in
+
+A L<Maypole::Headers> object containing HTTP headers for the request
+
+=head3 headers_out
+
+A L<HTTP::Headers> object that contains HTTP headers for the output
+
=head3 parse_args
Turns post data and query string paramaters into a hash of C<params>.
Maypole
backend. Otherwise, see L<Maypole::Config/"template_root">
+=head3 get_request
+
+You should only need to define this method if you are writing a new
+Maypole backend. It should return something that looks like an Apache
+or CGI request object, it defaults to blank.
+
+
=head3 is_applicable
Returns a Maypole::Constant to indicate whether the request is valid.
$r->template_args->{foo} = 'bar';
- Get/set a hash of template variables.
+Get/set a hash of template variables.
=head3 template
Sends the output and additional headers to the user.
+=head3 call_authenticate
+
+This method first checks if the relevant model class
+can authenticate the user, or falls back to the default
+authenticate method of your Maypole application.
+
+
+=head3 call_exception
+
+This model is called to catch exceptions, first after authenticate
+,then after processing the model class, and finally to check for
+exceptions from the view class.
+
+This method first checks if the relevant model class
+can handle exceptions the user, or falls back to the default
+exception method of your Maypole application.
+
+
+=head3 handler
+
+This method sets up the class if it's not done yet, sets some
+defaults and leaves the dirty work to handler_guts.
+
+=head3 handler_guts
+
+This is the core of maypole. You don't want to know.
+
=head1 SEE ALSO
There's more documentation, examples, and a wiki at the Maypole web
L<Maypole::Application>,L<Apache::MVC>, L<CGI::Maypole>.
-=head1 MAINTAINER
+=head1 AUTHOR
Sebastian Riedel, c<sri@oook.de>
-=head1 AUTHOR
+=head1 AUTHOR EMERITUS
Simon Cozens, C<simon@cpan.org>
-=head1 THANK YOU
+=head1 THANKS TO
-Danijel Milicevic, Jesse Scheidlower, Jody Belka, Marcus Ramberg,
-Mickael Joanne, Simon Flack, Veljko Vidovic and all the others who've
-helped.
+Danijel Milicevic, Dave Slack, Jesse Sheidlower, Jody Belka, Marcus Ramberg,
+Mickael Joanne, Randal Schwartz, Simon Flack, Steve Simms, Veljko Vidovic
+and all the others who've helped.
=head1 LICENSE
projects / maypole.git / blobdiff