1 package Catalyst::View::TT;
4 use base qw/Catalyst::View/;
10 our $VERSION = '0.25';
12 __PACKAGE__->mk_accessors('template');
13 __PACKAGE__->mk_accessors('include_path');
15 *paths = \&include_path;
19 Catalyst::View::TT - Template View Class
23 # use the helper to create your View
24 myapp_create.pl view TT TT
26 # configure in lib/MyApp.pm
30 root => MyApp->path_to('root');,
32 # any TT configurations items go here
34 MyApp->path_to( 'root', 'src' ),
35 MyApp->path_to( 'root', 'lib' ),
37 PRE_PROCESS => 'config/main',
38 WRAPPER => 'site/wrapper',
39 TEMPLATE_EXTENSION => '.tt',
41 # two optional config items
42 CATALYST_VAR => 'Catalyst',
47 # render view from lib/MyApp.pm or lib/MyApp::C::SomeController.pm
49 sub message : Global {
50 my ( $self, $c ) = @_;
51 $c->stash->{template} = 'message.tt2';
52 $c->stash->{message} = 'Hello World!';
53 $c->forward('MyApp::V::TT');
56 # access variables from template
58 The message is: [% message %].
60 # example when CATALYST_VAR is set to 'Catalyst'
61 Context is [% Catalyst %]
62 The base is [% Catalyst.req.base %]
63 The name is [% Catalyst.config.name %]
65 # example when CATALYST_VAR isn't set
67 The base is [% base %]
68 The name is [% name %]
73 my ( $paths, $dlim ) = shift;
74 return () if ( !$paths );
75 return @{$paths} if ( ref $paths eq 'ARRAY' );
77 # tweak delim to ignore C:/
78 unless ( defined $dlim ) {
79 $dlim = ( $^O eq 'MSWin32' ) ? ':(?!\\/)' : ':';
81 return split( /$dlim/, $paths );
85 my ( $class, $c, $arguments ) = @_;
88 TEMPLATE_EXTENSION => '',
92 if ( ! (ref $config->{INCLUDE_PATH} eq 'ARRAY') ) {
93 my $delim = $config->{DELIMITER};
95 = _coerce_paths( $config->{INCLUDE_PATH}, $delim );
96 if ( !@include_path ) {
97 my $root = $c->config->{root};
98 my $base = Path::Class::dir( $root, 'base' );
99 @include_path = ( "$root", "$base" );
101 $config->{INCLUDE_PATH} = \@include_path;
104 # if we're debugging and/or the TIMER option is set, then we install
105 # Template::Timer as a custom CONTEXT object, but only if we haven't
106 # already got a custom CONTEXT defined
108 if ( $config->{TIMER} ) {
109 if ( $config->{CONTEXT} ) {
111 'Cannot use Template::Timer - a TT CONTEXT is already defined'
115 $config->{CONTEXT} = Template::Timer->new(%$config);
119 if ( $c->debug && $config->{DUMP_CONFIG} ) {
120 $c->log->debug( "TT Config: ", dump($config) );
122 if ( $config->{PROVIDERS} ) {
124 if ( ref($config->{PROVIDERS}) eq 'ARRAY') {
125 foreach my $p (@{$config->{PROVIDERS}}) {
126 my $pname = $p->{name};
127 my $prov = 'Template::Provider';
128 if($pname eq '_file_')
130 $p->{args} = { %$config };
134 $prov .="::$pname" if($pname ne '_file_');
136 eval "require $prov";
138 push @providers, "$prov"->new($p->{args});
142 $c->log->warn("Can't load $prov, ($@)");
146 delete $config->{PROVIDERS};
148 $config->{LOAD_TEMPLATES} = \@providers;
152 my $self = $class->NEXT::new(
156 # Set base include paths. Local'd in render if needed
157 $self->include_path($config->{INCLUDE_PATH});
159 $self->config($config);
161 # Creation of template outside of call to new so that we can pass [ $self ]
162 # as INCLUDE_PATH config item, which then gets ->paths() called to get list
163 # of include paths to search for templates.
165 # Use a weakend copy of self so we dont have loops preventing GC from working
167 Scalar::Util::weaken($copy);
168 $config->{INCLUDE_PATH} = [ sub { $copy->paths } ];
171 Template->new($config) || do {
172 my $error = Template->error();
173 $c->log->error($error);
183 my ( $self, $c ) = @_;
185 my $template = $c->stash->{template}
186 || $c->action . $self->config->{TEMPLATE_EXTENSION};
188 unless (defined $template) {
189 $c->log->debug('No template specified for rendering') if $c->debug;
193 my $output = $self->render($c, $template);
195 if (UNIVERSAL::isa($output, 'Template::Exception')) {
196 my $error = qq/Couldn't render template "$output"/;
197 $c->log->error($error);
202 unless ( $c->response->content_type ) {
203 $c->response->content_type('text/html; charset=utf-8');
206 $c->response->body($output);
212 my ($self, $c, $template, $args) = @_;
214 $c->log->debug(qq/Rendering template "$template"/) if $c->debug;
218 (ref $args eq 'HASH' ? %$args : %{ $c->stash() }),
219 $self->template_vars($c)
222 local $self->{include_path} =
223 [ @{ $vars->{additional_template_paths} }, @{ $self->{include_path} } ]
224 if ref $vars->{additional_template_paths};
226 unless ($self->template->process( $template, $vars, \$output ) ) {
227 return $self->template->error;
234 my ( $self, $c ) = @_;
236 my $cvar = $self->config->{CATALYST_VAR};
242 base => $c->req->base,
243 name => $c->config->{name}
254 This is the Catalyst view class for the L<Template Toolkit|Template>.
255 Your application should defined a view class which is a subclass of
256 this module. The easiest way to achieve this is using the
257 F<myapp_create.pl> script (where F<myapp> should be replaced with
258 whatever your application is called). This script is created as part
259 of the Catalyst setup.
261 $ script/myapp_create.pl view TT TT
263 This creates a MyApp::V::TT.pm module in the F<lib> directory (again,
264 replacing C<MyApp> with the name of your application) which looks
267 package FooBar::V::TT;
270 use base 'Catalyst::View::TT';
272 __PACKAGE__->config->{DEBUG} = 'all';
274 Now you can modify your action handlers in the main application and/or
275 controllers to forward to your view class. You might choose to do this
276 in the end() method, for example, to automatically forward all actions
277 to the TT view class.
279 # In MyApp or MyApp::Controller::SomeController
282 my( $self, $c ) = @_;
283 $c->forward('MyApp::V::TT');
288 There are a three different ways to configure your view class. The
289 first way is to call the C<config()> method in the view subclass. This
290 happens when the module is first loaded.
292 package MyApp::V::TT;
295 use base 'Catalyst::View::TT';
297 MyApp::V::TT->config({
299 MyApp->path_to( 'root', 'templates', 'lib' ),
300 MyApp->path_to( 'root', 'templates', 'src' ),
302 PRE_PROCESS => 'config/main',
303 WRAPPER => 'site/wrapper',
306 The second way is to define a C<new()> method in your view subclass.
307 This performs the configuration when the view object is created,
308 shortly after being loaded. Remember to delegate to the base class
309 C<new()> method (via C<$self-E<gt>NEXT::new()> in the example below) after
310 performing any configuration.
316 MyApp->path_to( 'root', 'templates', 'lib' ),
317 MyApp->path_to( 'root', 'templates', 'src' ),
319 PRE_PROCESS => 'config/main',
320 WRAPPER => 'site/wrapper',
322 return $self->NEXT::new(@_);
325 The final, and perhaps most direct way, is to define a class
326 item in your main application configuration, again by calling the
327 uniquitous C<config()> method. The items in the class hash are
328 added to those already defined by the above two methods. This happens
329 in the base class new() method (which is one reason why you must
330 remember to call it via C<NEXT> if you redefine the C<new()> method in a
340 root => MyApp->path_to('root'),
343 MyApp->path_to( 'root', 'templates', 'lib' ),
344 MyApp->path_to( 'root', 'templates', 'src' ),
346 PRE_PROCESS => 'config/main',
347 WRAPPER => 'site/wrapper',
351 Note that any configuration items defined by one of the earlier
352 methods will be overwritten by items of the same name provided by the
355 =head2 DYNAMIC INCLUDE_PATH
357 Sometimes it is desirable to modify INCLUDE_PATH for your templates at run time.
359 Additional paths can be added to the start of INCLUDE_PATH via the stash as
362 $c->stash->{additional_template_paths} =
363 [$c->config->{root} . '/test_include_path'];
365 If you need to add paths to the end of INCLUDE_PATH, there is also an
366 include_path() accessor available:
368 push( @{ $c->view('TT')->include_path }, qw/path/ );
370 Note that if you use include_path() to add extra paths to INCLUDE_PATH, you
371 MUST check for duplicate paths. Without such checking, the above code will add
372 "path" to INCLUDE_PATH at every request, causing a memory leak.
374 A safer approach is to use include_path() to overwrite the array of paths
375 rather than adding to it. This eliminates both the need to perform duplicate
376 checking and the chance of a memory leak:
378 @{ $c->view('TT')->include_path } = qw/path another_path/;
380 If you are calling C<render> directly then you can specify dynamic paths by
381 having a C<additional_template_paths> key with a value of additonal directories
382 to search. See L<CAPTURING TEMPLATE OUTPUT> for an example showing this.
384 =head2 RENDERING VIEWS
386 The view plugin renders the template specified in the C<template>
389 sub message : Global {
390 my ( $self, $c ) = @_;
391 $c->stash->{template} = 'message.tt2';
392 $c->forward('MyApp::V::TT');
395 If a stash item isn't defined, then it instead uses the
396 stringification of the action dispatched to (as defined by $c->action)
397 in the above example, this would be C<message>, but because the default
398 is to append '.tt', it would load C<root/message.tt>.
400 The items defined in the stash are passed to the Template Toolkit for
401 use as template variables.
403 sub default : Private {
404 my ( $self, $c ) = @_;
405 $c->stash->{template} = 'message.tt2';
406 $c->stash->{message} = 'Hello World!';
407 $c->forward('MyApp::V::TT');
410 A number of other template variables are also added:
412 c A reference to the context object, $c
413 base The URL base, from $c->req->base()
414 name The application name, from $c->config->{ name }
416 These can be accessed from the template in the usual way:
420 The message is: [% message %]
421 The base is [% base %]
422 The name is [% name %]
425 The output generated by the template is stored in C<< $c->response->body >>.
427 =head2 CAPTURING TEMPLATE OUTPUT
429 If you wish to use the output of a template for some other purpose than
430 displaying in the response, e.g. for sending an email, this is possible using
431 L<Catalyst::Plugin::Email> and the L<render> method:
433 sub send_email : Local {
438 To => 'me@localhost',
439 Subject => 'A TT Email',
441 body => $c->view('TT')->render($c, 'email.tt', {
442 additional_template_paths => [ $c->config->{root} . '/email_templates'],
443 email_tmpl_param1 => 'foo'
447 # Redirect or display a message
450 =head2 TEMPLATE PROFILING
452 See L<C<TIMER>> property of the L<config> method.
460 The constructor for the TT view. Sets up the template provider,
461 and reads the application config.
465 Renders the template specified in C<< $c->stash->{template} >> or
466 C<< $c->action >> (the private name of the matched action. Calls L<render> to
467 perform actual rendering. Output is stored in C<< $c->response->body >>.
469 =item render($c, $template, \%args)
471 Renders the given template and returns output, or a L<Template::Exception>
474 The template variables are set to C<%$args> if $args is a hashref, or
475 $C<< $c->stash >> otherwise. In either case the variables are augmented with
476 C<base> set to C< << $c->req->base >>, C<c> to C<$c> and C<name> to
477 C<< $c->config->{name} >>. Alternately, the C<CATALYST_VAR> configuration item
478 can be defined to specify the name of a template variable through which the
479 context reference (C<$c>) can be accessed. In this case, the C<c>, C<base> and
480 C<name> variables are omitted.
482 C<$template> can be anything that Template::process understands how to
483 process, including the name of a template file or a reference to a test string.
484 See L<Template::process|Template/process> for a full list of supported formats.
488 Returns a list of keys/values to be used as the catalyst variables in the
493 This method allows your view subclass to pass additional settings to
494 the TT configuration hash, or to set the options as below:
498 =item C<CATALYST_VAR>
500 Allows you to change the name of the Catalyst context object. If set, it will also
501 remove the base and name aliases, so you will have access them through <context>.
507 root => MyApp->path_to('root'),
509 CATALYST_VAR => 'Catalyst',
515 The base is [% Catalyst.req.base %]
516 The name is [% Catalyst.config.name %]
520 If you have configured Catalyst for debug output, and turned on the TIMER setting,
521 C<Catalyst::View::TT> will enable profiling of template processing
522 (using L<Template::Timer>). This will embed HTML comments in the
523 output from your templates, such as:
525 <!-- TIMER START: process mainmenu/mainmenu.ttml -->
526 <!-- TIMER START: include mainmenu/cssindex.tt -->
527 <!-- TIMER START: process mainmenu/cssindex.tt -->
528 <!-- TIMER END: process mainmenu/cssindex.tt (0.017279 seconds) -->
529 <!-- TIMER END: include mainmenu/cssindex.tt (0.017401 seconds) -->
533 <!-- TIMER END: process mainmenu/footer.tt (0.003016 seconds) -->
536 =item C<TEMPLATE_EXTENSION>
538 a sufix to add when looking for templates bases on the C<match> method in L<Catalyst::Request>.
542 package MyApp::C::Test;
543 sub test : Local { .. }
545 Would by default look for a template in <root>/test/test. If you set TEMPLATE_EXTENSION to '.tt', it will look for
554 The L<Catalyst::Helper::View::TT> and
555 L<Catalyst::Helper::View::TTSite> helper modules are provided to create
556 your view module. There are invoked by the F<myapp_create.pl> script:
558 $ script/myapp_create.pl view TT TT
560 $ script/myapp_create.pl view TT TTSite
562 The L<Catalyst::Helper::View::TT> module creates a basic TT view
563 module. The L<Catalyst::Helper::View::TTSite> module goes a little
564 further. It also creates a default set of templates to get you
565 started. It also configures the view module to locate the templates
570 L<Catalyst>, L<Catalyst::Helper::View::TT>,
571 L<Catalyst::Helper::View::TTSite>, L<Template::Manual>
575 Sebastian Riedel, C<sri@cpan.org>
577 Marcus Ramberg, C<mramberg@cpan.org>
579 Jesse Sheidlower, C<jester@panix.com>
581 Andy Wardley, C<abw@cpan.org>
585 This program is free software, you can redistribute it and/or modify it
586 under the same terms as Perl itself.