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 my $error = "fatal error in template '$template_file' : $@\nTT paths : " . join(', ',$self->paths($r)) . "\n";
44 my $error = "TT error for template '$template_file'\n" . $self->{tt}->error . "\nTT paths : " . join(', ',$self->paths($r)) . "\n";
54 my ($self, $r, $error, $type) = @_;
57 warn "self : $self, r : $r, error : $error, type : $type\n";
59 # Need to be very careful here.
60 my $tt = Template->new;
61 unless (ref $r->{config}) {
62 warn "no config for this request\n";
63 $error .= '<br> There was a problem finding configuration for this request';
66 if ($tt->process(\$error_template,
67 { err_type => $type, error => $error,
68 config => $r->{config},
70 paths => $self->paths($r),
71 eval{$self->vars($r)} }, \$output )) {
72 $r->{output} = $output;
73 if ($tt->error) { $r->{output} = "<html><body>Even the error template
74 errored - ".$tt->error."</body></html>"; }
75 $r->{content_type} ||= "text/html";
76 $r->{document_encoding} ||= "utf-8";
85 Maypole::View::TT - A Template Toolkit view class for Maypole
89 BeerDB->config->view("Maypole::View::TT"); # The default anyway
91 # Set some Template Toolkit options
92 BeerDB->config->view_options( {
94 COMPILE_DIR => '/var/tmp/mysite/templates',
105 [% maybe_link_view %]
109 This is the default view class for Maypole; it uses the Template Toolkit to fill
110 in templates with the objects produced by Maypole's model classes. Please see
111 the L<Maypole manual|Maypole::Manual>, and in particular, the
112 L<view|Maypole::Manual::View> chapter for the template variables available and
113 for a refresher on how template components are resolved.
115 The underlying Template toolkit object is configured through
116 C<$r-E<gt>config-E<gt>view_options>. See L<Template|Template> for available
123 Processes the template and sets the output. See L<Maypole::View::Base>
127 Reports the details of an error, current state and parameters
131 =head1 TEMPLATE TOOLKIT INTRODUCTION
133 The Template Toolkit uses it's own mini language described in
134 L<Template::Manual::Directives>.
136 A simple example would be :
142 Dear [% title %] [% surname %],
143 Thank you for your letter dated [% your.date %]. This is to
144 confirm that we have received it and will respond with a more
145 detailed response as soon as possible. In the mean time, we
146 enclose more details of ...
150 TT uses '[%' and '%]' (by default) to delimit directives within a template, and
151 the simple directives above just display the value of variable named within
152 those delimiters -- [% title %] will be replaced inline with the value of the
153 'title' variable passed in the 'stash' to the template when it is processed.
155 You can access nested data through the dot ('.') operator, which will
156 dereference array or hash elements, but can also be used to call methods on
157 objects, i.e. '[% name.salutation("Dear %s,") %]'. The other main operator is
158 underscore ('_'), which will concatonate strings or variables.
160 The value returned by a directive replaces the directive inline when the
161 template is processes, you can also SET a value which will not return anything,
162 or CALL a method or operation which will also not return anything.
164 You can specify expressions using the logical (and, or, not, ?:) and mathematic
165 operators (+ - * / % mod div).
167 Results of TT commands are interpolated in the place of the template tags, unless
168 using SET or CALL, i.e. [% SET foo = 1 %], [% GET foo.bar('quz'); %]
172 [% template.title or default.title %]
176 [% order.nitems ? checkout(order.total) : 'no items' %]
180 TT allows you to include or re-use templates through it's INCLUDE, PROCESS and
181 INSERT directives, which are fairly self explainatory. You can also re-use parts
182 of template with the BLOCK or MACRO directives.
184 Conditional and Looping constructs are simple and powerful, and TT provides an
185 inbuilt iterator and helper functions and classes that make life sweet.
187 Conditional directives are IF, UNLESS, ELSIF, ELSE and behave as they would in
193 Hello [% name %], does your mother know you're using her AOL account?
195 Sorry, you're not old enough to enter (and too dumb to lie about your age)
200 [% UNLESS text_mode %] [% INCLUDE biglogo %] [% END %]
204 Looping directives are FOREACH, LAST and BREAK.
206 FOREACH loops through a HASH or ARRAY processing the enclosed block for each
209 Looping through an array
211 [% FOREACH i = items %]
215 Looping through a hash
217 [% FOREACH u IN users %]
218 * [% u.key %] : [% u.value %]
221 Looping through an array of hashes
223 [% FOREACH user IN userlist %]
224 * [% user.id %] [% user.name %]
227 The LAST and BREAK directive can be used to exit the loop.
229 The FOREACH directive is implemented using the Template::Iterator module. A
230 reference to the iterator object for a FOREACH directive is implicitly available
231 in the 'loop' variable. The loop iterator object provides a selection of methods
232 including size(), max(), first(), last(), count(), etc
236 [% FOREACH item IN [ 'foo', 'bar', 'baz' ] -%]
237 [%- "<ul>\n" IF loop.first %]
238 <li>[% loop.count %]/[% loop.size %]: [% item %]
239 [%- "</ul>\n" IF loop.last %]
244 See Template::Iterator for further details on looping and the Iterator.
246 You might notice the minus ('-') operator in the example above, it is used to
247 remove a newline before or after a directive so that you can layout the Template
248 logic as above but the resulting output will look exactly how you require it.
250 You will also frequently see comments and multi-line directives, # at the start
251 of a directive marks it as a comment, i.e. '[%# this is a comment %]'. A
252 multiline directive looks like :
258 You can see that lines are terminated with a semi-colon (';') unless the
259 delimter ('%]') closes the directive.
261 For full details of the Template Toolkit see Template::Manual and
262 Template::Manual::Directives, you can also check the website, mailing list or
263 the Template Toolkit book published by O Reilly.
265 =head1 TEMPLATE PLUGINS, FILTERS AND MACROS
267 The Template Toolkit has a popular and powerful selection of Plugins and
270 TT Plugins provide additional functionality within Templates, from accessing CGI
271 and databases directly, handling paging or simple integration with Class::DBI
272 (for those rare occasions where you don't actually need Maypole). See
273 L<Template::Manual::Plugins>.
275 One plugin that is indispensible when using Maypole and the Template View is
276 C<Template::Plugin::Class> -- This allows you to import and use any class
277 installed within a template. For example :
281 [% USE foo = Class('Foo') %]
286 Would do the equivilent of 'use Foo; Foo->bar;' in perl. See
287 L<Template::Plugin::Class> for details.
289 TT Filters process strings or blocks within a template, allowing you to
290 truncate, format, escape or encode trivially. A useful selection is included
291 with Template Toolkit and they can also be found on CPAN or can be written
292 easily. See L<Template::Manual::Filters>.
294 TT provides stderr and stdout filters, which allow you to write handy macros
295 like this one to output debug information to your web server log, etc :
299 [% MACRO debug_msg(text)
300 FILTER stderr; "[TT debug_msg] $text\n"; END;
306 TT Macros allow you to reuse small blocks of content, directives, etc. The MACRO
307 directive allows you to define a directive or directive block which is then
308 evaluated each time the macro is called. Macros can be passed named parameters
311 Once a MACRO is defined within a template or 'include'd template it can be used
312 as if it were a native TT directive. Maypole provides a selection of powerful
313 and useful macros in the templates/ directory of the package and these are used
314 in the beerdb and default templates. See the MACRO section of the
315 L<Template::Manual::Directives> documentation.
317 =head1 ACCESSING MAYPOLE VALUES
321 You can access the request in your templates in order to see the action, table, etc as well
322 as parameters passed through forms :
326 Hello [% request.params.forename %] [% request.params.surname %] !
330 Are you want to [% request.action %] in the [% request.table %] ?
334 You can access your maypole application configuration through the config variable :
336 <link base="[% config.uri_base %]"/>
338 =head2 object and objects
340 Objects are passed to the request using r->objects($arrayref) and are accessed in the templates
341 as an array called objects.
343 [% FOR objects %] <a href="[% config.uri_base %]/[% request.table %]/view/[% object.id %]"> [% object %] </a> [% END %]
345 =head1 MAYPOLE MACROS AND FILTERS
347 Maypole provides a collection of useful and powerful macros in the templates/factory/macros
348 and other templates. These can be used in any template with [% PROCESS templatename %].
352 This creates an <A HREF="..."> to a command in the Apache::MVC system by
353 catenating the base URL, table, command, and any arguments.
355 =head2 maybe_link_view
357 C<maybe_link_view> takes something returned from the database - either
358 some ordinary data, or an object in a related class expanded by a
359 has-a relationship. If it is an object, it constructs a link to the view
360 command for that object. Otherwise, it just displays the data.
364 This is an include template rather than a macro, and it controls the pager
365 display at the bottom (by default) of the factory list and search views/template.
366 It expects a C<pager> template argument which responds to the L<Data::Page> interface.
368 This macro is in the pager template and used as :
372 Maypole provides a pager for list and search actions, otherwise you can
373 provide a pager in the template using Template::Plugin::Pagination.
375 [% USE pager = Pagination(objects, page.current, page.rows) %]
379 The pager will use a the request action as the action in the url unless the
380 pager_action variable is set, which it will use instead if available.
393 <html><head><title>Maypole error page</title>
394 <style type="text/css">
395 body { background-color:#7d95b5; font-family: sans-serif}
396 p { background-color: #fff; padding: 5px; }
397 pre { background-color: #fff; padding: 5px; border: 1px dotted black }
400 .lhs {background-color: #ffd; }
401 .rhs {background-color: #dff; }
404 <h1> Maypole application error </h1>
406 <p> This application living at <code>[%request.config.uri_base%]</code>,
407 [%request.config.application_name || "which is unnamed" %], has
408 produced an error. The adminstrator should be able to understand
409 this error message and fix the problem.</p>
411 <h2> Some basic facts </h2>
413 <p> The error was found in the [% err_type %] stage of processing
414 the path "[% request.path %]". The error text returned was:
420 <h2> Request details </h2>
422 <table width="85%" cellspacing="2" cellpadding="1">
423 [% FOR attribute = ["model_class", "table", "template", "path",
424 "content_type", "document_encoding", "action", "args", "objects"] %]
425 <tr> <td class="lhs" width="35%"> <b>[% attribute %]</b> </td> <td class="rhs" width="65%"> [%
426 request.$attribute.list.join(" , ") %] </td></tr>
428 <tr><td colspan="2"></tr>
429 <tr><td class="lhs" colspan="2"><b>CGI Parameters</b> </td></tr>
430 [% FOREACH param IN request.params %]
431 <tr> <td class="lhs" width="35%">[% param.key %]</td> <td class="rhs" width="65%"> [% param.value %] </td></tr>
435 <h2> Website / Template Paths </h2>
436 <table width="85%" cellspacing="2" cellpadding="1">
437 <tr><td class="lhs" width="35%"> <b>Base URI</b> </td><td class="rhs" width="65%">[% request.config.uri_base %]</td></tr>
438 <tr><td class="lhs" width="35%"> <b>Paths</b> </td><td class="rhs" width="65%"> [% paths %] </td></tr>
441 <h2> Application configuration </h2>
442 <table width="85%" cellspacing="2" cellpadding="1">
443 <tr><td class="lhs" width="35%"> <b>Model </b> </td><td class="rhs" width="65%"> [% request.config.model %] </td></tr>
444 <tr><td class="lhs" width="35%"> <b>View </b> </td><td class="rhs" width="65%"> [% request.config.view %] </td></tr>
445 <tr><td class="lhs" width="35%"> <b>Classes</b> </td><td class="rhs" width="65%"> [% request.config.classes.list.join(" , ") %] </td></tr>
446 <tr><td class="lhs" width="35%"> <b>Tables</b> </td><td class="rhs" width="65%"> [% request.config.display_tables.list.join(" , ") %] </td></tr>