1 package Maypole::View::TT;
3 use base 'Maypole::View::Base';
4 use Maypole::Constants;
6 use File::Spec::Functions qw(catdir tmpdir);
9 { local $/; $error_template = <DATA>; }
11 our $VERSION = '2.11';
16 my ( $self, $r ) = @_;
17 unless ($self->{tt}) {
18 my $view_options = $r->config->view_options || {};
19 $self->{provider} = Template::Provider->new($view_options);
20 $self->{tt} = Template->new({
22 LOAD_TEMPLATES => [ $self->{provider} ],
26 $self->{provider}->include_path([ $self->paths($r) ]);
28 my $template_file = $r->template;
30 my $ext = $r->config->template_extension;
31 $template_file .= $ext if defined $ext;
34 my $processed_ok = eval{$self->{tt}->process($template_file, { $self->vars($r) }, \$output );};
36 $r->{output} = $output;
40 warn "fatal error in template '$template_file' : $@\n";
41 $r->{error} = "fatal error in template '$template_file' : $@";
43 warn "TT error for template '$template_file'\n" . $self->{tt}->error;
44 $r->{error} = "TT error for template '$template_file'\n" . $self->{tt}->error;
52 my ($self, $r, $error, $type) = @_;
55 warn "self : $self, r : $r, error : $error, type : $type\n";
57 # Need to be very careful here.
58 my $tt = Template->new;
59 unless (ref $r->{config}) {
60 warn "no config for this request\n";
61 $error .= '<br> There was a problem finding configuration for this request';
64 if ($tt->process(\$error_template,
65 { err_type => $type, error => $error,
66 config => $r->{config},
68 paths => $self->paths($r),
69 eval{$self->vars($r)} }, \$output )) {
70 $r->{output} = $output;
71 if ($tt->error) { $r->{output} = "<html><body>Even the error template
72 errored - ".$tt->error."</body></html>"; }
73 $r->{content_type} ||= "text/html";
74 $r->{document_encoding} ||= "utf-8";
83 Maypole::View::TT - A Template Toolkit view class for Maypole
87 BeerDB->config->view("Maypole::View::TT"); # The default anyway
89 # Set some Template Toolkit options
90 BeerDB->config->view_options( {
92 COMPILE_DIR => '/var/tmp/mysite/templates',
103 [% maybe_link_view %]
107 This is the default view class for Maypole; it uses the Template Toolkit to fill
108 in templates with the objects produced by Maypole's model classes. Please see
109 the L<Maypole manual|Maypole::Manual>, and in particular, the
110 L<view|Maypole::Manual::View> chapter for the template variables available and
111 for a refresher on how template components are resolved.
113 The underlying Template toolkit object is configured through
114 C<$r-E<gt>config-E<gt>view_options>. See L<Template|Template> for available
121 Processes the template and sets the output. See L<Maypole::View::Base>
125 Reports the details of an error, current state and parameters
129 =head1 TEMPLATE TOOLKIT INTRODUCTION
131 The Template Toolkit uses it's own mini language described in
132 L<Template::Manual::Directives>.
134 A simple example would be :
140 Dear [% title %] [% surname %],
141 Thank you for your letter dated [% your.date %]. This is to
142 confirm that we have received it and will respond with a more
143 detailed response as soon as possible. In the mean time, we
144 enclose more details of ...
148 TT uses '[%' and '%]' (by default) to delimit directives within a template, and
149 the simple directives above just display the value of variable named within
150 those delimiters -- [% title %] will be replaced inline with the value of the
151 'title' variable passed in the 'stash' to the template when it is processed.
153 You can access nested data through the dot ('.') operator, which will
154 dereference array or hash elements, but can also be used to call methods on
155 objects, i.e. '[% name.salutation("Dear %s,") %]'. The other main operator is
156 underscore ('_'), which will concatonate strings or variables.
158 The value returned by a directive replaces the directive inline when the
159 template is processes, you can also SET a value which will not return anything,
160 or CALL a method or operation which will also not return anything.
162 You can specify expressions using the logical (and, or, not, ?:) and mathematic
163 operators (+ - * / % mod div).
165 Results of TT commands are interpolated in the place of the template tags, unless
166 using SET or CALL, i.e. [% SET foo = 1 %], [% GET foo.bar('quz'); %]
170 [% template.title or default.title %]
174 [% order.nitems ? checkout(order.total) : 'no items' %]
178 TT allows you to include or re-use templates through it's INCLUDE, PROCESS and
179 INSERT directives, which are fairly self explainatory. You can also re-use parts
180 of template with the BLOCK or MACRO directives.
182 Conditional and Looping constructs are simple and powerful, and TT provides an
183 inbuilt iterator and helper functions and classes that make life sweet.
185 Conditional directives are IF, UNLESS, ELSIF, ELSE and behave as they would in
191 Hello [% name %], does your mother know you're using her AOL account?
193 Sorry, you're not old enough to enter (and too dumb to lie about your age)
198 [% UNLESS text_mode %] [% INCLUDE biglogo %] [% END %]
202 Looping directives are FOREACH, LAST and BREAK.
204 FOREACH loops through a HASH or ARRAY processing the enclosed block for each
207 Looping through an array
209 [% FOREACH i = items %]
213 Looping through a hash
215 [% FOREACH u IN users %]
216 * [% u.key %] : [% u.value %]
219 Looping through an array of hashes
221 [% FOREACH user IN userlist %]
222 * [% user.id %] [% user.name %]
225 The LAST and BREAK directive can be used to exit the loop.
227 The FOREACH directive is implemented using the Template::Iterator module. A
228 reference to the iterator object for a FOREACH directive is implicitly available
229 in the 'loop' variable. The loop iterator object provides a selection of methods
230 including size(), max(), first(), last(), count(), etc
234 [% FOREACH item IN [ 'foo', 'bar', 'baz' ] -%]
235 [%- "<ul>\n" IF loop.first %]
236 <li>[% loop.count %]/[% loop.size %]: [% item %]
237 [%- "</ul>\n" IF loop.last %]
242 See Template::Iterator for further details on looping and the Iterator.
244 You might notice the minus ('-') operator in the example above, it is used to
245 remove a newline before or after a directive so that you can layout the Template
246 logic as above but the resulting output will look exactly how you require it.
248 You will also frequently see comments and multi-line directives, # at the start
249 of a directive marks it as a comment, i.e. '[%# this is a comment %]'. A
250 multiline directive looks like :
256 You can see that lines are terminated with a semi-colon (';') unless the
257 delimter ('%]') closes the directive.
259 For full details of the Template Toolkit see Template::Manual and
260 Template::Manual::Directives, you can also check the website, mailing list or
261 the Template Toolkit book published by O Reilly.
263 =head1 TEMPLATE PLUGINS, FILTERS AND MACROS
265 The Template Toolkit has a popular and powerful selection of Plugins and
268 TT Plugins provide additional functionality within Templates, from accessing CGI
269 and databases directly, handling paging or simple integration with Class::DBI
270 (for those rare occasions where you don't actually need Maypole). See
271 L<Template::Manual::Plugins>.
273 One plugin that is indispensible when using Maypole and the Template View is
274 C<Template::Plugin::Class> -- This allows you to import and use any class
275 installed within a template. For example :
279 [% USE foo = Class('Foo') %]
284 Would do the equivilent of 'use Foo; Foo->bar;' in perl. See
285 L<Template::Plugin::Class> for details.
287 TT Filters process strings or blocks within a template, allowing you to
288 truncate, format, escape or encode trivially. A useful selection is included
289 with Template Toolkit and they can also be found on CPAN or can be written
290 easily. See L<Template::Manual::Filters>.
292 TT provides stderr and stdout filters, which allow you to write handy macros
293 like this one to output debug information to your web server log, etc :
297 [% MACRO debug_msg(text)
298 FILTER stderr; "[TT debug_msg] $text\n"; END;
304 TT Macros allow you to reuse small blocks of content, directives, etc. The MACRO
305 directive allows you to define a directive or directive block which is then
306 evaluated each time the macro is called. Macros can be passed named parameters
309 Once a MACRO is defined within a template or 'include'd template it can be used
310 as if it were a native TT directive. Maypole provides a selection of powerful
311 and useful macros in the templates/ directory of the package and these are used
312 in the beerdb and default templates. See the MACRO section of the
313 L<Template::Manual::Directives> documentation.
315 =head1 ACCESSING MAYPOLE VALUES
319 You can access the request in your templates in order to see the action, table, etc as well
320 as parameters passed through forms :
324 Hello [% request.params.forename %] [% request.params.surname %] !
328 Are you want to [% request.action %] in the [% request.table %] ?
332 You can access your maypole application configuration through the config variable :
334 <link base="[% config.uri_base %]"/>
336 =head2 object and objects
338 Objects are passed to the request using r->objects($arrayref) and are accessed in the templates
339 as an array called objects.
341 [% FOR objects %] <a href="[% config.uri_base %]/[% request.table %]/view/[% object.id %]"> [% object %] </a> [% END %]
343 =head1 MAYPOLE MACROS AND FILTERS
345 Maypole provides a collection of useful and powerful macros in the templates/factory/macros
346 and other templates. These can be used in any template with [% PROCESS templatename %].
350 This creates an <A HREF="..."> to a command in the Apache::MVC system by
351 catenating the base URL, table, command, and any arguments.
353 =head2 maybe_link_view
355 C<maybe_link_view> takes something returned from the database - either
356 some ordinary data, or an object in a related class expanded by a
357 has-a relationship. If it is an object, it constructs a link to the view
358 command for that object. Otherwise, it just displays the data.
362 This is an include template rather than a macro, and it controls the pager
363 display at the bottom (by default) of the factory list and search views/template.
364 It expects a C<pager> template argument which responds to the L<Data::Page> interface.
366 This macro is in the pager template and used as :
370 Maypole provides a pager for list and search actions, otherwise you can
371 provide a pager in the template using Template::Plugin::Pagination.
373 [% USE pager = Pagination(objects, page.current, page.rows) %]
377 The pager will use a the request action as the action in the url unless the
378 pager_action variable is set, which it will use instead if available.
391 <html><head><title>Maypole error page</title>
392 <style type="text/css">
393 body { background-color:#7d95b5; font-family: sans-serif}
394 p { background-color: #fff; padding: 5px; }
395 pre { background-color: #fff; padding: 5px; border: 1px dotted black }
398 .lhs {background-color: #ffd; }
399 .rhs {background-color: #dff; }
402 <h1> Maypole application error </h1>
404 <p> This application living at <code>[%request.config.uri_base%]</code>,
405 [%request.config.application_name || "which is unnamed" %], has
406 produced an error. The adminstrator should be able to understand
407 this error message and fix the problem.</p>
409 <h2> Some basic facts </h2>
411 <p> The error was found in the [% err_type %] stage of processing
412 the path "[% request.path %]". The error text returned was:
418 <h2> Request details </h2>
420 <table width="85%" cellspacing="2" cellpadding="1">
421 [% FOR attribute = ["model_class", "table", "template", "path",
422 "content_type", "document_encoding", "action", "args", "objects"] %]
423 <tr> <td class="lhs" width="35%"> <b>[% attribute %]</b> </td> <td class="rhs" width="65%"> [%
424 request.$attribute.list.join(" , ") %] </td></tr>
428 <h2> Website / Template Paths </h2>
429 <table width="85%" cellspacing="2" cellpadding="1">
430 <tr><td class="lhs" width="35%"> <b>Base URI</b> </td><td class="rhs" width="65%">[% request.config.uri_base %]</td></tr>
431 <tr><td class="lhs" width="35%"> <b>Paths</b> </td><td class="rhs" width="65%"> [% paths %] </td></tr>
434 <h2> Application configuration </h2>
435 <table width="85%" cellspacing="2" cellpadding="1">
436 <tr><td class="lhs" width="35%"> <b>Model </b> </td><td class="rhs" width="65%"> [% request.config.model %] </td></tr>
437 <tr><td class="lhs" width="35%"> <b>View </b> </td><td class="rhs" width="65%"> [% request.config.view %] </td></tr>
438 <tr><td class="lhs" width="35%"> <b>Classes</b> </td><td class="rhs" width="65%"> [% request.config.classes.list.join(" , ") %] </td></tr>
439 <tr><td class="lhs" width="35%"> <b>Tables</b> </td><td class="rhs" width="65%"> [% request.config.display_tables.list.join(" , ") %] </td></tr>