1 package Maypole::View::TT;
2 use base 'Maypole::View::Base';
3 use Maypole::Constants;
5 use File::Spec::Functions qw(catdir tmpdir);
8 { local $/; $error_template = <DATA>; }
13 my ( $self, $r ) = @_;
14 unless ($self->{tt}) {
15 my $view_options = $r->config->view_options || {};
16 $self->{provider} = Template::Provider->new($view_options);
17 $self->{tt} = Template->new({
19 LOAD_TEMPLATES => [ $self->{provider} ],
23 $self->{provider}->include_path([ $self->paths($r) ]);
25 my $template_file = $r->template;
27 my $ext = $r->config->template_extension;
28 $template_file .= $ext if defined $ext;
31 my $processed_ok = eval{$self->{tt}->process($template_file, { $self->vars($r) }, \$output );};
33 $r->{output} = $output;
37 warn "fatal error in template '$template_file' : $@\n";
38 $r->{error} = "fatal error in template '$template_file' : $@";
40 warn "TT error for template '$template_file'\n" . $self->{tt}->error;
41 $r->{error} = "TT error for template '$template_file'\n" . $self->{tt}->error;
49 my ($self, $r, $error, $type) = @_;
52 warn "self : $self, r : $r, error : $error, type : $type\n";
54 # Need to be very careful here.
55 my $tt = Template->new;
56 unless (ref $r->{config}) {
57 warn "no config for this request\n";
58 $error .= '<br> There was a problem finding configuration for this request';
61 if ($tt->process(\$error_template,
62 { err_type => $type, error => $error,
63 config => $r->{config},
65 paths => $self->paths($r),
66 eval{$self->vars($r)} }, \$output )) {
67 $r->{output} = $output;
68 if ($tt->error) { $r->{output} = "<html><body>Even the error template
69 errored - ".$tt->error."</body></html>"; }
70 $r->{content_type} ||= "text/html";
71 $r->{document_encoding} ||= "utf-8";
80 Maypole::View::TT - A Template Toolkit view class for Maypole
84 BeerDB->config->view("Maypole::View::TT"); # The default anyway
86 # Set some Template Toolkit options
87 BeerDB->config->view_options( {
89 COMPILE_DIR => '/var/tmp/mysite/templates',
100 [% maybe_link_view %]
104 This is the default view class for Maypole; it uses the Template Toolkit to fill
105 in templates with the objects produced by Maypole's model classes. Please see
106 the L<Maypole manual|Maypole::Manual>, and in particular, the
107 L<view|Maypole::Manual::View> chapter for the template variables available and
108 for a refresher on how template components are resolved.
110 The underlying Template toolkit object is configured through
111 C<$r-E<gt>config-E<gt>view_options>. See L<Template|Template> for available
118 Processes the template and sets the output. See L<Maypole::View::Base>
122 Reports the details of an error, current state and parameters
126 =head1 TEMPLATE TOOLKIT INTRODUCTION
128 The Template Toolkit uses it's own mini language described in
129 L<Template::Manual::Directives>.
131 A simple example would be :
137 Dear [% title %] [% surname %],
138 Thank you for your letter dated [% your.date %]. This is to
139 confirm that we have received it and will respond with a more
140 detailed response as soon as possible. In the mean time, we
141 enclose more details of ...
145 TT uses '[%' and '%]' (by default) to delimit directives within a template, and
146 the simple directives above just display the value of variable named within
147 those delimiters -- [% title %] will be replaced inline with the value of the
148 'title' variable passed in the 'stash' to the template when it is processed.
150 You can access nested data through the dot ('.') operator, which will
151 dereference array or hash elements, but can also be used to call methods on
152 objects, i.e. '[% name.salutation("Dear %s,") %]'. The other main operator is
153 underscore ('_'), which will concatonate strings or variables.
155 The value returned by a directive replaces the directive inline when the
156 template is processes, you can also SET a value which will not return anything,
157 or CALL a method or operation which will also not return anything.
159 You can specify expressions using the logical (and, or, not, ?:) and mathematic
160 operators (+ - * / % mod div).
162 Results of TT commands are interpolated in the place of the template tags, unless
163 using SET or CALL, i.e. [% SET foo = 1 %], [% GET foo.bar('quz'); %]
167 [% template.title or default.title %]
171 [% order.nitems ? checkout(order.total) : 'no items' %]
175 TT allows you to include or re-use templates through it's INCLUDE, PROCESS and
176 INSERT directives, which are fairly self explainatory. You can also re-use parts
177 of template with the BLOCK or MACRO directives.
179 Conditional and Looping constructs are simple and powerful, and TT provides an
180 inbuilt iterator and helper functions and classes that make life sweet.
182 Conditional directives are IF, UNLESS, ELSIF, ELSE and behave as they would in
188 Hello [% name %], does your mother know you're using her AOL account?
190 Sorry, you're not old enough to enter (and too dumb to lie about your age)
195 [% UNLESS text_mode %] [% INCLUDE biglogo %] [% END %]
199 Looping directives are FOREACH, LAST and BREAK.
201 FOREACH loops through a HASH or ARRAY processing the enclosed block for each
204 Looping through an array
206 [% FOREACH i = items %]
210 Looping through a hash
212 [% FOREACH u IN users %]
213 * [% u.key %] : [% u.value %]
216 Looping through an array of hashes
218 [% FOREACH user IN userlist %]
219 * [% user.id %] [% user.name %]
222 The LAST and BREAK directive can be used to exit the loop.
224 The FOREACH directive is implemented using the Template::Iterator module. A
225 reference to the iterator object for a FOREACH directive is implicitly available
226 in the 'loop' variable. The loop iterator object provides a selection of methods
227 including size(), max(), first(), last(), count(), etc
231 [% FOREACH item IN [ 'foo', 'bar', 'baz' ] -%]
232 [%- "<ul>\n" IF loop.first %]
233 <li>[% loop.count %]/[% loop.size %]: [% item %]
234 [%- "</ul>\n" IF loop.last %]
239 See Template::Iterator for further details on looping and the Iterator.
241 You might notice the minus ('-') operator in the example above, it is used to
242 remove a newline before or after a directive so that you can layout the Template
243 logic as above but the resulting output will look exactly how you require it.
245 You will also frequently see comments and multi-line directives, # at the start
246 of a directive marks it as a comment, i.e. '[%# this is a comment %]'. A
247 multiline directive looks like :
253 You can see that lines are terminated with a semi-colon (';') unless the
254 delimter ('%]') closes the directive.
256 For full details of the Template Toolkit see Template::Manual and
257 Template::Manual::Directives, you can also check the website, mailing list or
258 the Template Toolkit book published by O Reilly.
260 =head1 TEMPLATE PLUGINS, FILTERS AND MACROS
262 The Template Toolkit has a popular and powerful selection of Plugins and
265 TT Plugins provide additional functionality within Templates, from accessing CGI
266 and databases directly, handling paging or simple integration with Class::DBI
267 (for those rare occasions where you don't actually need Maypole). See
268 L<Template::Manual::Plugins>.
270 One plugin that is indispensible when using Maypole and the Template View is
271 C<Template::Plugin::Class> -- This allows you to import and use any class
272 installed within a template. For example :
276 [% USE foo = Class('Foo') %]
281 Would do the equivilent of 'use Foo; Foo->bar;' in perl. See
282 L<Template::Plugin::Class> for details.
284 TT Filters process strings or blocks within a template, allowing you to
285 truncate, format, escape or encode trivially. A useful selection is included
286 with Template Toolkit and they can also be found on CPAN or can be written
287 easily. See L<Template::Manual::Filters>.
289 TT Macros allow you to reuse small blocks of content, directives, etc. The MACRO
290 directive allows you to define a directive or directive block which is then
291 evaluated each time the macro is called. Macros can be passed named parameters
294 Once a MACRO is defined within a template or 'include'd template it can be used
295 as if it were a native TT directive. Maypole provides a selection of powerful
296 and useful macros in the templates/ directory of the package and these are used
297 in the beerdb and default templates. See the MACRO section of the
298 L<Template::Manual::Directives> documentation.
300 =head1 ACCESSING MAYPOLE VALUES
304 You can access the request in your templates in order to see the action, table, etc as well
305 as parameters passed through forms :
309 Hello [% request.params.forename %] [% request.params.surname %] !
313 Are you want to [% request.action %] in the [% request.table %] ?
317 You can access your maypole application configuration through the config variable :
319 <link base="[% config.uri_base %]"/>
321 =head2 object and objects
323 Objects are passed to the request using r->objects($arrayref) and are accessed in the templates
324 as an array called objects.
326 [% FOR objects %] <a href="[% config.uri_base %]/[% request.table %]/view/[% object.id %]"> [% object %] </a> [% END %]
328 =head1 MAYPOLE MACROS AND FILTERS
330 Maypole provides a collection of useful and powerful macros in the templates/factory/macros
331 and other templates. These can be used in any template with [% PROCESS templatename %].
335 This creates an <A HREF="..."> to a command in the Apache::MVC system by
336 catenating the base URL, table, command, and any arguments.
338 =head2 maybe_link_view
340 C<maybe_link_view> takes something returned from the database - either
341 some ordinary data, or an object in a related class expanded by a
342 has-a relationship. If it is an object, it constructs a link to the view
343 command for that object. Otherwise, it just displays the data.
347 This is an include template rather than a macro, and it controls the pager
348 display at the bottom (by default) of the factory list and search views/template.
349 It expects a C<pager> template argument which responds to the L<Data::Page> interface.
351 This macro is in the pager template and used as :
355 Maypole provides a pager for list and search actions, otherwise you can
356 provide a pager in the template using Template::Plugin::Pagination.
358 [% USE pager = Pagination(objects, page.current, page.rows) %]
362 The pager will use a the request action as the action in the url unless the
363 pager_action variable is set, which it will use instead if available.
376 <html><head><title>Maypole error page</title>
377 <style type="text/css">
378 body { background-color:#7d95b5; font-family: sans-serif}
379 p { background-color: #fff; padding: 5px; }
380 pre { background-color: #fff; padding: 5px; border: 1px dotted black }
383 .lhs {background-color: #ffd; }
384 .rhs {background-color: #dff; }
387 <h1> Maypole application error </h1>
389 <p> This application living at <code>[%request.config.uri_base%]</code>,
390 [%request.config.application_name || "which is unnamed" %], has
391 produced an error. The adminstrator should be able to understand
392 this error message and fix the problem.</p>
394 <h2> Some basic facts </h2>
396 <p> The error was found in the [% err_type %] stage of processing
397 the path "[% request.path %]". The error text returned was:
403 <h2> Request details </h2>
405 <table width="85%" cellspacing="2" cellpadding="1">
406 [% FOR attribute = ["model_class", "table", "template", "path",
407 "content_type", "document_encoding", "action", "args", "objects"] %]
408 <tr> <td class="lhs" width="35%"> <b>[% attribute %]</b> </td> <td class="rhs" width="65%"> [%
409 request.$attribute.list.join(" , ") %] </td></tr>
413 <h2> Website / Template Paths </h2>
414 <table width="85%" cellspacing="2" cellpadding="1">
415 <tr><td class="lhs" width="35%"> <b>Base URI</b> </td><td class="rhs" width="65%">[% request.config.uri_base %]</td></tr>
416 <tr><td class="lhs" width="35%"> <b>Paths</b> </td><td class="rhs" width="65%"> [% paths %] </td></tr>
419 <h2> Application configuration </h2>
420 <table width="85%" cellspacing="2" cellpadding="1">
421 <tr><td class="lhs" width="35%"> <b>Model </b> </td><td class="rhs" width="65%"> [% request.config.model %] </td></tr>
422 <tr><td class="lhs" width="35%"> <b>View </b> </td><td class="rhs" width="65%"> [% request.config.view %] </td></tr>
423 <tr><td class="lhs" width="35%"> <b>Classes</b> </td><td class="rhs" width="65%"> [% request.config.classes.list.join(" , ") %] </td></tr>
424 <tr><td class="lhs" width="35%"> <b>Tables</b> </td><td class="rhs" width="65%"> [% request.config.display_tables.list.join(" , ") %] </td></tr>