Commit | Line | Data |
8077080c |
1 | package Catalyst::View::TT; |
2 | |
3 | use strict; |
7d8aa5ec |
4 | use base qw/Catalyst::View/; |
8077080c |
5 | use Template; |
6 | use Template::Timer; |
7 | use NEXT; |
8 | |
07571b2f |
9 | our $VERSION = '0.20'; |
8077080c |
10 | |
11 | __PACKAGE__->mk_accessors('template'); |
e2bbd784 |
12 | __PACKAGE__->mk_accessors('include_path'); |
8077080c |
13 | |
14 | =head1 NAME |
15 | |
16 | Catalyst::View::TT - Template View Class |
17 | |
18 | =head1 SYNOPSIS |
19 | |
8cd017a8 |
20 | # use the helper to create View |
722fede4 |
21 | myapp_create.pl view TT TT |
8077080c |
22 | |
8cd017a8 |
23 | # configure in lib/MyApp.pm |
24 | |
8cd017a8 |
25 | MyApp->config({ |
26 | name => 'MyApp', |
7d8aa5ec |
27 | root => MyApp->path_to('root');, |
7d607671 |
28 | 'V::TT' => { |
8cd017a8 |
29 | # any TT configurations items go here |
30 | INCLUDE_PATH => [ |
93f25382 |
31 | MyApp->path_to( 'root', 'src' ), |
32 | MyApp->path_to( 'root', 'lib' ), |
8cd017a8 |
33 | ], |
07571b2f |
34 | PRE_PROCESS => 'config/main', |
35 | WRAPPER => 'site/wrapper', |
36 | TEMPLATE_EXTENSION => '.tt', |
8cd017a8 |
37 | |
38 | # two optional config items |
39 | CATALYST_VAR => 'Catalyst', |
40 | TIMER => 1, |
41 | }, |
42 | }); |
43 | |
44 | # render view from lib/MyApp.pm or lib/MyApp::C::SomeController.pm |
45 | |
46 | sub message : Global { |
94b3529a |
47 | my ( $self, $c ) = @_; |
48 | $c->stash->{template} = 'message.tt2'; |
49 | $c->stash->{message} = 'Hello World!'; |
8cd017a8 |
50 | $c->forward('MyApp::V::TT'); |
51 | } |
8077080c |
52 | |
8cd017a8 |
53 | # access variables from template |
54 | |
55 | The message is: [% message %]. |
56 | |
57 | # example when CATALYST_VAR is set to 'Catalyst' |
58 | Context is [% Catalyst %] |
59 | The base is [% Catalyst.req.base %] |
60 | The name is [% Catalyst.config.name %] |
61 | |
62 | # example when CATALYST_VAR isn't set |
63 | Context is [% c %] |
64 | The base is [% base %] |
65 | The name is [% name %] |
66 | |
67 | =head1 DESCRIPTION |
68 | |
69 | This is the Catalyst view class for the L<Template Toolkit|Template>. |
70 | Your application should defined a view class which is a subclass of |
71 | this module. The easiest way to achieve this is using the |
72 | F<myapp_create.pl> script (where F<myapp> should be replaced with |
73 | whatever your application is called). This script is created as part |
74 | of the Catalyst setup. |
75 | |
76 | $ script/myapp_create.pl view TT TT |
77 | |
78 | This creates a MyApp::V::TT.pm module in the F<lib> directory (again, |
79 | replacing C<MyApp> with the name of your application) which looks |
80 | something like this: |
81 | |
82 | package FooBar::V::TT; |
83 | |
84 | use strict; |
85 | use base 'Catalyst::View::TT'; |
8077080c |
86 | |
87 | __PACKAGE__->config->{DEBUG} = 'all'; |
88 | |
8cd017a8 |
89 | Now you can modify your action handlers in the main application and/or |
90 | controllers to forward to your view class. You might choose to do this |
91 | in the end() method, for example, to automatically forward all actions |
92 | to the TT view class. |
722fede4 |
93 | |
8cd017a8 |
94 | # In MyApp or MyApp::Controller::SomeController |
8077080c |
95 | |
8cd017a8 |
96 | sub end : Private { |
94b3529a |
97 | my( $self, $c ) = @_; |
8cd017a8 |
98 | $c->forward('MyApp::V::TT'); |
99 | } |
8077080c |
100 | |
8cd017a8 |
101 | =head2 CONFIGURATION |
4687ac0d |
102 | |
8cd017a8 |
103 | There are a three different ways to configure your view class. The |
104 | first way is to call the C<config()> method in the view subclass. This |
105 | happens when the module is first loaded. |
8077080c |
106 | |
8cd017a8 |
107 | package MyApp::V::TT; |
108 | |
109 | use strict; |
110 | use base 'Catalyst::View::TT'; |
722fede4 |
111 | |
8cd017a8 |
112 | MyApp::V::TT->config({ |
7d8aa5ec |
113 | INCLUDE_PATH => [ |
114 | MyApp->path_to( 'root', 'templates', 'lib' ), |
115 | MyApp->path_to( 'root', 'templates', 'src' ), |
116 | ], |
8cd017a8 |
117 | PRE_PROCESS => 'config/main', |
118 | WRAPPER => 'site/wrapper', |
119 | }); |
120 | |
121 | The second way is to define a C<new()> method in your view subclass. |
122 | This performs the configuration when the view object is created, |
123 | shortly after being loaded. Remember to delegate to the base class |
124 | C<new()> method (via C<$self-E<gt>NEXT::new()> in the example below) after |
125 | performing any configuration. |
126 | |
127 | sub new { |
128 | my $self = shift; |
129 | $self->config({ |
7d8aa5ec |
130 | INCLUDE_PATH => [ |
131 | MyApp->path_to( 'root', 'templates', 'lib' ), |
132 | MyApp->path_to( 'root', 'templates', 'src' ), |
133 | ], |
8cd017a8 |
134 | PRE_PROCESS => 'config/main', |
135 | WRAPPER => 'site/wrapper', |
136 | }); |
137 | return $self->NEXT::new(@_); |
138 | } |
139 | |
94b3529a |
140 | The final, and perhaps most direct way, is to define a class |
8cd017a8 |
141 | item in your main application configuration, again by calling the |
94b3529a |
142 | uniquitous C<config()> method. The items in the class hash are |
8cd017a8 |
143 | added to those already defined by the above two methods. This happens |
144 | in the base class new() method (which is one reason why you must |
145 | remember to call it via C<NEXT> if you redefine the C<new()> method in a |
146 | subclass). |
147 | |
148 | package MyApp; |
149 | |
150 | use strict; |
151 | use Catalyst; |
152 | |
8cd017a8 |
153 | MyApp->config({ |
154 | name => 'MyApp', |
7d8aa5ec |
155 | root => MyApp->path_to('root'), |
7d607671 |
156 | 'V::TT' => { |
7d8aa5ec |
157 | INCLUDE_PATH => [ |
158 | MyApp->path_to( 'root', 'templates', 'lib' ), |
159 | MyApp->path_to( 'root', 'templates', 'src' ), |
160 | ], |
8cd017a8 |
161 | PRE_PROCESS => 'config/main', |
162 | WRAPPER => 'site/wrapper', |
163 | }, |
164 | }); |
165 | |
166 | Note that any configuration items defined by one of the earlier |
167 | methods will be overwritten by items of the same name provided by the |
168 | latter methods. |
169 | |
e2bbd784 |
170 | =head2 DYNAMIC INCLUDE_PATH |
171 | |
172 | It is sometimes needed to dynamically add additional paths to the |
173 | INCLUDE_PATH variable of the template object. This can be done by setting |
174 | 'additional_include_paths' on stash to a referrence to an array with |
175 | additional paths: |
176 | |
177 | $c->stash->{additional_template_paths} = [$c->config->{root} . '/test_include_path']; |
178 | |
8cd017a8 |
179 | =head2 RENDERING VIEWS |
180 | |
181 | The view plugin renders the template specified in the C<template> |
182 | item in the stash. |
183 | |
184 | sub message : Global { |
94b3529a |
185 | my ( $self, $c ) = @_; |
186 | $c->stash->{template} = 'message.tt2'; |
8cd017a8 |
187 | $c->forward('MyApp::V::TT'); |
188 | } |
722fede4 |
189 | |
94b3529a |
190 | If a class item isn't defined, then it instead uses the |
8cd017a8 |
191 | current match, as returned by C<$c-E<gt>match>. In the above |
192 | example, this would be C<message>. |
193 | |
194 | The items defined in the stash are passed to the Template Toolkit for |
195 | use as template variables. |
196 | |
197 | sub message : Global { |
198 | sub default : Private { |
94b3529a |
199 | my ( $self, $c ) = @_; |
200 | $c->stash->{template} = 'message.tt2'; |
201 | $c->stash->{message} = 'Hello World!'; |
8cd017a8 |
202 | $c->forward('MyApp::V::TT'); |
203 | } |
7b592fc7 |
204 | |
8cd017a8 |
205 | A number of other template variables are also added: |
8077080c |
206 | |
8cd017a8 |
207 | c A reference to the context object, $c |
208 | base The URL base, from $c->req->base() |
209 | name The application name, from $c->config->{ name } |
210 | |
211 | These can be accessed from the template in the usual way: |
212 | |
213 | <message.tt2>: |
214 | |
215 | The message is: [% message %] |
216 | The base is [% base %] |
217 | The name is [% name %] |
218 | |
8cd017a8 |
219 | |
220 | The output generated by the template is stored in |
221 | C<$c-E<gt>response-E<gt>output>. |
222 | |
223 | =head2 TEMPLATE PROFILING |
224 | |
caa61517 |
225 | =head2 METHODS |
8077080c |
226 | |
2774dc77 |
227 | =over 4 |
228 | |
229 | =item new |
230 | |
231 | The constructor for the TT view. Sets up the template provider, |
232 | and reads the application config. |
233 | |
8077080c |
234 | =cut |
235 | |
83056300 |
236 | sub _coerce_paths { |
e2bbd784 |
237 | my ( $paths, $dlim ) = shift; |
bec996dc |
238 | return () if ( !$paths ); |
239 | return @{$paths} if ( ref $paths eq 'ARRAY' ); |
9300af5b |
240 | |
bec996dc |
241 | # tweak delim to ignore C:/ |
242 | unless ( defined $dlim ) { |
243 | $dlim = ( $^O eq 'MSWin32' ) ? ':(?!\\/)' : ':'; |
244 | } |
245 | return split( /$dlim/, $paths ); |
246 | } |
9300af5b |
247 | |
e2bbd784 |
248 | sub new { |
249 | my ( $class, $c, $arguments ) = @_; |
250 | my $delim = $class->config->{DELIMITER} || $arguments->{DELIMITER}; |
3a4ffa2a |
251 | my $include_path; |
bec996dc |
252 | if ( ref $arguments->{INCLUDE_PATH} eq 'ARRAY' ) { |
3a4ffa2a |
253 | $include_path = $arguments->{INCLUDE_PATH}; |
bec996dc |
254 | } |
255 | elsif ( ref $class->config->{INCLUDE_PATH} eq 'ARRAY' ) { |
3a4ffa2a |
256 | $include_path = $class->config->{INCLUDE_PATH}; |
bec996dc |
257 | } |
258 | else { |
259 | my @include_path |
260 | = _coerce_paths( $arguments->{INCLUDE_PATH}, $delim ); |
261 | if ( !@include_path ) { |
262 | @include_path |
263 | = _coerce_paths( $class->config->{INCLUDE_PATH}, $delim ); |
3a4ffa2a |
264 | } |
bec996dc |
265 | if ( !@include_path ) { |
3a4ffa2a |
266 | my $root = $c->config->{root}; |
bec996dc |
267 | my $base = Path::Class::dir( $root, 'base' ); |
3a4ffa2a |
268 | @include_path = ( "$root", "$base" ); |
269 | } |
270 | $include_path = \@include_path; |
e2bbd784 |
271 | } |
94b3529a |
272 | my $config = { |
7d8aa5ec |
273 | EVAL_PERL => 0, |
4729c102 |
274 | TEMPLATE_EXTENSION => '', |
9300af5b |
275 | %{ $class->config }, |
e2bbd784 |
276 | %{$arguments}, |
3a4ffa2a |
277 | INCLUDE_PATH => $include_path, |
94b3529a |
278 | }; |
62728755 |
279 | |
8cd017a8 |
280 | # if we're debugging and/or the TIMER option is set, then we install |
281 | # Template::Timer as a custom CONTEXT object, but only if we haven't |
282 | # already got a custom CONTEXT defined |
283 | |
dccfa0ff |
284 | if ( $config->{TIMER} ) { |
94b3529a |
285 | if ( $config->{CONTEXT} ) { |
8cd017a8 |
286 | $c->log->error( |
bec996dc |
287 | 'Cannot use Template::Timer - a TT CONFIG is already defined' |
288 | ); |
8cd017a8 |
289 | } |
290 | else { |
94b3529a |
291 | $config->{CONTEXT} = Template::Timer->new(%$config); |
8cd017a8 |
292 | } |
293 | } |
294 | |
94b3529a |
295 | if ( $c->debug && $config->{DUMP_CONFIG} ) { |
8cd017a8 |
296 | use Data::Dumper; |
94b3529a |
297 | $c->log->debug( "TT Config: ", Dumper($config) ); |
62728755 |
298 | } |
299 | |
e3a53d5b |
300 | my $self = $class->NEXT::new( |
8cd017a8 |
301 | $c, |
bec996dc |
302 | { template => Template->new($config) || do { |
8cd017a8 |
303 | my $error = Template->error(); |
304 | $c->log->error($error); |
305 | $c->error($error); |
306 | return undef; |
bec996dc |
307 | }, |
308 | %{$config}, |
48d69085 |
309 | }, |
8cd017a8 |
310 | ); |
3a4ffa2a |
311 | $self->include_path($include_path); |
e3a53d5b |
312 | $self->config($config); |
313 | |
314 | return $self; |
8077080c |
315 | } |
316 | |
2774dc77 |
317 | =item process |
8077080c |
318 | |
722fede4 |
319 | Renders the template specified in C<$c-E<gt>stash-E<gt>{template}> or |
320 | C<$c-E<gt>request-E<gt>match>. Template variables are set up from the |
321 | contents of C<$c-E<gt>stash>, augmented with C<base> set to |
322 | C<$c-E<gt>req-E<gt>base>, C<c> to C<$c> and C<name> to |
8cd017a8 |
323 | C<$c-E<gt>config-E<gt>{name}>. Alternately, the C<CATALYST_VAR> |
324 | configuration item can be defined to specify the name of a template |
325 | variable through which the context reference (C<$c>) can be accessed. |
326 | In this case, the C<c>, C<base> and C<name> variables are omitted. |
327 | Output is stored in C<$c-E<gt>response-E<gt>output>. |
8077080c |
328 | |
329 | =cut |
330 | |
331 | sub process { |
332 | my ( $self, $c ) = @_; |
23042c3c |
333 | |
7d8aa5ec |
334 | my $template = $c->stash->{template} |
bec996dc |
335 | || ( $c->request->match || $c->request->action ) |
336 | . $self->config->{TEMPLATE_EXTENSION}; |
23042c3c |
337 | |
338 | unless ($template) { |
8077080c |
339 | $c->log->debug('No template specified for rendering') if $c->debug; |
340 | return 0; |
341 | } |
23042c3c |
342 | |
343 | $c->log->debug(qq/Rendering template "$template"/) if $c->debug; |
23042c3c |
344 | |
8cd017a8 |
345 | my $output; |
346 | my $cvar = $self->config->{CATALYST_VAR}; |
347 | my $vars = { |
348 | defined $cvar |
349 | ? ( $cvar => $c ) |
bec996dc |
350 | : ( c => $c, |
8cd017a8 |
351 | base => $c->req->base, |
352 | name => $c->config->{name} |
353 | ), |
354 | %{ $c->stash() } |
355 | }; |
bec996dc |
356 | unshift @{ $self->include_path }, |
357 | @{ $c->stash->{additional_template_paths} } |
358 | if ref $c->stash->{additional_template_paths}; |
8cd017a8 |
359 | unless ( $self->template->process( $template, $vars, \$output ) ) { |
8077080c |
360 | my $error = $self->template->error; |
361 | $error = qq/Couldn't render template "$error"/; |
362 | $c->log->error($error); |
becb7ac2 |
363 | $c->error($error); |
23042c3c |
364 | return 0; |
365 | } |
bec996dc |
366 | splice @{ $self->include_path }, 0, |
367 | scalar @{ $c->stash->{additional_template_paths} } |
368 | if ref $c->stash->{additional_template_paths}; |
369 | |
23042c3c |
370 | unless ( $c->response->content_type ) { |
371 | $c->response->content_type('text/html; charset=utf-8'); |
8077080c |
372 | } |
23042c3c |
373 | |
374 | $c->response->body($output); |
375 | |
8077080c |
376 | return 1; |
377 | } |
378 | |
2774dc77 |
379 | =item config |
8077080c |
380 | |
8cd017a8 |
381 | This method allows your view subclass to pass additional settings to |
4729c102 |
382 | the TT configuration hash, or to set the options as below: |
383 | |
384 | =over 2 |
385 | |
386 | =item C<CATALYST_VAR> |
387 | |
388 | Allows you to change the name of the Catalyst context object. If set, it will also |
389 | remove the base and name aliases, so you will have access them through <context>. |
390 | |
391 | For example: |
392 | |
393 | MyApp->config({ |
394 | name => 'MyApp', |
7d8aa5ec |
395 | root => MyApp->path_to('root'), |
4729c102 |
396 | 'V::TT' => { |
397 | CATALYST_VAR => 'Catalyst', |
398 | }, |
399 | }); |
400 | |
401 | F<message.tt2>: |
402 | |
403 | The base is [% Catalyst.req.base %] |
404 | The name is [% Catalyst.config.name %] |
405 | |
406 | =item C<TIMER> |
407 | |
408 | If you have configured Catalyst for debug output, and turned on the TIMER setting, |
409 | C<Catalyst::View::TT> will enable profiling of template processing |
410 | (using L<Template::Timer>). This will embed HTML comments in the |
411 | output from your templates, such as: |
412 | |
413 | <!-- TIMER START: process mainmenu/mainmenu.ttml --> |
414 | <!-- TIMER START: include mainmenu/cssindex.tt --> |
415 | <!-- TIMER START: process mainmenu/cssindex.tt --> |
416 | <!-- TIMER END: process mainmenu/cssindex.tt (0.017279 seconds) --> |
417 | <!-- TIMER END: include mainmenu/cssindex.tt (0.017401 seconds) --> |
418 | |
419 | .... |
420 | |
421 | <!-- TIMER END: process mainmenu/footer.tt (0.003016 seconds) --> |
422 | |
423 | |
be7c1afa |
424 | =item C<TEMPLATE_EXTENSION> |
4729c102 |
425 | |
747f2b6d |
426 | a sufix to add when looking for templates bases on the C<match> method in L<Catalyst::Request>. |
4729c102 |
427 | |
428 | For example: |
429 | |
430 | package MyApp::C::Test; |
431 | sub test : Local { .. } |
432 | |
433 | Would by default look for a template in <root>/test/test. If you set TEMPLATE_EXTENSION to '.tt', it will look for |
434 | <root>/test/test.tt. |
435 | |
436 | =back |
8077080c |
437 | |
2774dc77 |
438 | =back |
8077080c |
439 | |
8cd017a8 |
440 | =head2 HELPERS |
441 | |
442 | The L<Catalyst::Helper::View::TT> and |
443 | L<Catalyst::Helper::View::TTSite> helper modules are provided to create |
444 | your view module. There are invoked by the F<myapp_create.pl> script: |
445 | |
446 | $ script/myapp_create.pl view TT TT |
447 | |
448 | $ script/myapp_create.pl view TT TTSite |
449 | |
450 | The L<Catalyst::Helper::View::TT> module creates a basic TT view |
451 | module. The L<Catalyst::Helper::View::TTSite> module goes a little |
452 | further. It also creates a default set of templates to get you |
453 | started. It also configures the view module to locate the templates |
454 | automatically. |
455 | |
8077080c |
456 | =head1 SEE ALSO |
457 | |
8cd017a8 |
458 | L<Catalyst>, L<Catalyst::Helper::View::TT>, |
459 | L<Catalyst::Helper::View::TTSite>, L<Template::Manual> |
8077080c |
460 | |
c0eb0527 |
461 | =head1 AUTHORS |
8077080c |
462 | |
463 | Sebastian Riedel, C<sri@cpan.org> |
c0eb0527 |
464 | |
d938377b |
465 | Marcus Ramberg, C<mramberg@cpan.org> |
c0eb0527 |
466 | |
722fede4 |
467 | Jesse Sheidlower, C<jester@panix.com> |
c0eb0527 |
468 | |
8cd017a8 |
469 | Andy Wardley, C<abw@cpan.org> |
8077080c |
470 | |
471 | =head1 COPYRIGHT |
472 | |
2774dc77 |
473 | This program is free software, you can redistribute it and/or modify it |
474 | under the same terms as Perl itself. |
8077080c |
475 | |
476 | =cut |
477 | |
478 | 1; |