use Template;
use File::Spec::Functions qw(catdir tmpdir);
+our $error_template;
+{ local $/; $error_template = <DATA>; }
+
use strict;
our $VERSION = 2.11;
if ($self->{tt}->process($template_file, { $self->vars($r) }, \$output )) {
$r->{output} = $output;
return OK;
- }
- else {
+ } else {
$r->{error} = "TT error for template '$template_file'\n" . $self->{tt}->error;
return ERROR;
}
}
-1;
+
+sub report_error {
+ my ($self, $r, $error, $type) = @_;
+ my $output;
+ # Need to be very careful here.
+ my $tt = Template->new;
+ if ($tt->process(\$error_template,
+ { err_type => $type, error => $error,
+ config => { %{$r->{config}}},
+ request => $r, # We have that at least
+ eval{$self->vars($r)} }, \$output )) {
+ $r->{output} = $output;
+ if ($tt->error) { $r->{output} = "<html><body>Even the error template
+ errored - ".$tt->error."</body></html>"; }
+ $r->{content_type} ||= "text/html";
+ $r->{document_encoding} ||= "utf-8";
+ return OK;
+ }
+ return ERROR;
+}
+
=head1 NAME
.....
- [%# Template Toolkit directives and maypole macros go here %]
+ [% PROCESS macros %]
+
+ [% pager %]
+
+ [% link %]
+
+ [% maybe_link_view %]
=head1 DESCRIPTION
Processes the template and sets the output. See L<Maypole::View::Base>
+=item report_error
+
+Reports the details of an error, current state and parameters
+
=back
=head1 TEMPLATE TOOLKIT INTRODUCTION
You can specify expressions using the logical (and, or, not, ?:) and mathematic
operators (+ - * / % mod div).
+Results of TT commands are interpolated in the place of the template tags, unless
+using SET or CALL, i.e. [% SET foo = 1 %], [% GET foo.bar('quz'); %]
+
=over 4
[% template.title or default.title %]
in the beerdb and default templates. See the MACRO section of the
L<Template::Manual::Directives> documentation.
+=head1 ACCESSING MAYPOLE VALUES
+
+=head2 request
+
+You can access the request in your templates in order to see the action, table, etc as well
+as parameters passed through forms :
+
+for example
+
+Hello [% request.params.forename %] [% request.params.surname %] !
+
+or
+
+Are you want to [% request.action %] in the [% request.table %] ?
+
+=head2 config
+
+You can access your maypole application configuration through the config variable :
+
+<link base="[% config.uri_base %]"/>
+
+=head2 object and objects
+
+Objects are passed to the request using r->objects($arrayref) and are accessed in the templates
+as an array called objects.
+
+[% FOR objects %] <a href="[% config.uri_base %]/[% request.table %]/view/[% object.id %]"> [% object %] </a> [% END %]
+
=head1 MAYPOLE MACROS AND FILTERS
-Maypole provides a collection of useful and powerful macros...TO DO
+Maypole provides a collection of useful and powerful macros in the templates/factory/macros
+ and other templates. These can be used in any template with [% PROCESS templatename %].
=head2 link
-=head2 other macros
+This creates an <A HREF="..."> to a command in the Apache::MVC system by
+catenating the base URL, table, command, and any arguments.
+
+=head2 maybe_link_view
+
+C<maybe_link_view> takes something returned from the database - either
+some ordinary data, or an object in a related class expanded by a
+has-a relationship. If it is an object, it constructs a link to the view
+command for that object. Otherwise, it just displays the data.
+
+=head2 pager
-=head2 finish this documentation
+This is an include template rather than a macro, and it controls the pager
+display at the bottom (by default) of the factory list and search views/template.
+It expects a C<pager> template argument which responds to the L<Data::Page> interface.
+
+This macro is in the pager template and used as :
+
+[% PROCESS pager %]
+
+Maypole provides a pager for list and search actions, otherwise you can
+provide a pager in the template using Template::Plugin::Pagination.
+
+[% USE pager = Pagination(objects, page.current, page.rows) %]
+...
+[% PROCESS pager %]
+
+The pager will use a the request action as the action in the url unless the
+pager_action variable is set, which it will use instead if available.
+
+=head2 other macros
=head1 AUTHOR
=cut
+1;
+
+__DATA__
+<html><head><title>Maypole error page</title>
+<style type="text/css">
+body { background-color:#7d95b5; font-family: sans-serif}
+p { background-color: #fff; padding: 5px; }
+pre { background-color: #fff; padding: 5px; border: 1px dotted black }
+h1 { color: #fff }
+h2 { color: #fff }
+.lhs {background-color: #ffd; }
+.rhs {background-color: #dff; }
+</style>
+</head> <body>
+<h1> Maypole application error </h1>
+
+<p> This application living at <code>[%request.config.uri_base%]</code>,
+[%request.config.application_name || "which is unnamed" %], has
+produced an error. The adminstrator should be able to understand
+this error message and fix the problem.</p>
+
+<h2> Some basic facts </h2>
+
+<p> The error was found in the [% err_type %] stage of processing
+the path "[% request.path %]". The error text returned was:
+</p>
+<pre>
+ [% error %]
+</pre>
+
+<h2> Request details </h2>
+
+<table>
+ [% FOR thing = ["model_class", "table", "template", "path",
+ "content_type", "document_encoding", "action", "args", "objects"] %]
+ <tr> <td class="lhs"> [%thing %] </td> <td class="rhs"> [%
+ request.$thing.list.join(" , ") %] </td></tr>
+ [% END %]
+</table>
+
+<h2> Application configuration </h2>
+<table>
+ [% FOR thing = config.keys %]
+ <tr> <td class="lhs"> [%thing %] </td> <td class="rhs"> [%
+ config.$thing.list.join(" , ") %] </td></tr>
+ [% END %]
+</table>
+
+</body>
+</html>
+
+
projects / maypole.git / blobdiff