1 package Catalyst::View::TT;
6 use base qw/Catalyst::View/;
12 our $VERSION = '0.31';
14 __PACKAGE__->mk_accessors('template');
15 __PACKAGE__->mk_accessors('include_path');
17 *paths = \&include_path;
21 Catalyst::View::TT - Template View Class
25 # use the helper to create your View
27 myapp_create.pl view TT TT
29 # configure in lib/MyApp.pm (Could be set from configfile instead)
33 root => MyApp->path_to('root'),
35 # any TT configurations items go here
37 MyApp->path_to( 'root', 'src' ),
38 MyApp->path_to( 'root', 'lib' ),
40 TEMPLATE_EXTENSION => '.tt',
44 PRE_PROCESS => 'config/main',
45 WRAPPER => 'site/wrapper',
49 # render view from lib/MyApp.pm or lib/MyApp::Controller::SomeController.pm
51 sub message : Global {
52 my ( $self, $c ) = @_;
53 $c->stash->{template} = 'message.tt2';
54 $c->stash->{message} = 'Hello World!';
55 $c->forward( $c->view('TT') );
58 # access variables from template
60 The message is: [% message %].
62 # example when CATALYST_VAR is set to 'Catalyst'
63 Context is [% Catalyst %]
64 The base is [% Catalyst.req.base %]
65 The name is [% Catalyst.config.name %]
67 # example when CATALYST_VAR isn't set
69 The base is [% base %]
70 The name is [% name %]
75 my ( $paths, $dlim ) = shift;
76 return () if ( !$paths );
77 return @{$paths} if ( ref $paths eq 'ARRAY' );
79 # tweak delim to ignore C:/
80 unless ( defined $dlim ) {
81 $dlim = ( $^O eq 'MSWin32' ) ? ':(?!\\/)' : ':';
83 return split( /$dlim/, $paths );
87 my ( $class, $c, $arguments ) = @_;
90 TEMPLATE_EXTENSION => '',
94 if ( ! (ref $config->{INCLUDE_PATH} eq 'ARRAY') ) {
95 my $delim = $config->{DELIMITER};
97 = _coerce_paths( $config->{INCLUDE_PATH}, $delim );
98 if ( !@include_path ) {
99 my $root = $c->config->{root};
100 my $base = Path::Class::dir( $root, 'base' );
101 @include_path = ( "$root", "$base" );
103 $config->{INCLUDE_PATH} = \@include_path;
106 # if we're debugging and/or the TIMER option is set, then we install
107 # Template::Timer as a custom CONTEXT object, but only if we haven't
108 # already got a custom CONTEXT defined
110 if ( $config->{TIMER} ) {
111 if ( $config->{CONTEXT} ) {
113 'Cannot use Template::Timer - a TT CONTEXT is already defined'
117 $config->{CONTEXT} = Template::Timer->new(%$config);
121 if ( $c->debug && $config->{DUMP_CONFIG} ) {
122 $c->log->debug( "TT Config: ", dump($config) );
125 my $self = $class->next::method(
129 # Set base include paths. Local'd in render if needed
130 $self->include_path($config->{INCLUDE_PATH});
132 $self->config($config);
134 # Creation of template outside of call to new so that we can pass [ $self ]
135 # as INCLUDE_PATH config item, which then gets ->paths() called to get list
136 # of include paths to search for templates.
138 # Use a weakend copy of self so we dont have loops preventing GC from working
140 Scalar::Util::weaken($copy);
141 $config->{INCLUDE_PATH} = [ sub { $copy->paths } ];
143 if ( $config->{PROVIDERS} ) {
145 if ( ref($config->{PROVIDERS}) eq 'ARRAY') {
146 foreach my $p (@{$config->{PROVIDERS}}) {
147 my $pname = $p->{name};
148 my $prov = 'Template::Provider';
149 if($pname eq '_file_')
151 $p->{args} = { %$config };
155 if($pname =~ s/^\+//) {
162 # We copy the args people want from the config
165 if ($p->{copy_config}) {
166 map { $p->{args}->{$_} = $config->{$_} }
167 grep { exists $config->{$_} }
168 @{ $p->{copy_config} };
171 eval "require $prov";
173 push @providers, "$prov"->new($p->{args});
177 $c->log->warn("Can't load $prov, ($@)");
181 delete $config->{PROVIDERS};
183 $config->{LOAD_TEMPLATES} = \@providers;
188 Template->new($config) || do {
189 my $error = Template->error();
190 $c->log->error($error);
200 my ( $self, $c ) = @_;
202 my $template = $c->stash->{template}
203 || $c->action . $self->config->{TEMPLATE_EXTENSION};
205 unless (defined $template) {
206 $c->log->debug('No template specified for rendering') if $c->debug;
210 my $output = eval { $self->render($c, $template) };
212 my $error = qq/Couldn't render template "$template"/;
213 $c->log->error($error);
218 unless ( $c->response->content_type ) {
219 $c->response->content_type('text/html; charset=utf-8');
222 $c->response->body($output);
228 my ($self, $c, $template, $args) = @_;
230 $c->log->debug(qq/Rendering template "$template"/) if $c && $c->debug;
234 (ref $args eq 'HASH' ? %$args : %{ $c->stash() }),
235 $self->template_vars($c)
238 local $self->{include_path} =
239 [ @{ $vars->{additional_template_paths} }, @{ $self->{include_path} } ]
240 if ref $vars->{additional_template_paths};
242 $self->template->process( $template, $vars, \$output )
243 or die $self->template->error;
248 my ( $self, $c ) = @_;
251 my $cvar = $self->config->{CATALYST_VAR};
257 base => $c->req->base,
258 name => $c->config->{name}
269 This is the Catalyst view class for the L<Template Toolkit|Template>.
270 Your application should defined a view class which is a subclass of
271 this module. The easiest way to achieve this is using the
272 F<myapp_create.pl> script (where F<myapp> should be replaced with
273 whatever your application is called). This script is created as part
274 of the Catalyst setup.
276 $ script/myapp_create.pl view TT TT
278 This creates a MyApp::View::TT.pm module in the F<lib> directory (again,
279 replacing C<MyApp> with the name of your application) which looks
282 package FooBar::View::TT;
287 use base 'Catalyst::View::TT';
289 __PACKAGE__->config->{DEBUG} = 'all';
291 Now you can modify your action handlers in the main application and/or
292 controllers to forward to your view class. You might choose to do this
293 in the end() method, for example, to automatically forward all actions
294 to the TT view class.
296 # In MyApp or MyApp::Controller::SomeController
299 my( $self, $c ) = @_;
300 $c->forward( $c->view('TT') );
305 There are a three different ways to configure your view class. The
306 first way is to call the C<config()> method in the view subclass. This
307 happens when the module is first loaded.
309 package MyApp::View::TT;
312 use base 'Catalyst::View::TT';
314 MyApp::View::TT->config({
316 MyApp->path_to( 'root', 'templates', 'lib' ),
317 MyApp->path_to( 'root', 'templates', 'src' ),
319 PRE_PROCESS => 'config/main',
320 WRAPPER => 'site/wrapper',
323 The second way is to define a C<new()> method in your view subclass.
324 This performs the configuration when the view object is created,
325 shortly after being loaded. Remember to delegate to the base class
326 C<new()> method (via C<$self-E<gt>next::method()> in the example below) after
327 performing any configuration.
333 MyApp->path_to( 'root', 'templates', 'lib' ),
334 MyApp->path_to( 'root', 'templates', 'src' ),
336 PRE_PROCESS => 'config/main',
337 WRAPPER => 'site/wrapper',
339 return $self->next::method(@_);
342 The final, and perhaps most direct way, is to define a class
343 item in your main application configuration, again by calling the
344 ubiquitous C<config()> method. The items in the class hash are
345 added to those already defined by the above two methods. This happens
346 in the base class new() method (which is one reason why you must
347 remember to call it via C<MRO::Compat> if you redefine the C<new()>
348 method in a subclass).
357 root => MyApp->path_to('root'),
360 MyApp->path_to( 'root', 'templates', 'lib' ),
361 MyApp->path_to( 'root', 'templates', 'src' ),
363 PRE_PROCESS => 'config/main',
364 WRAPPER => 'site/wrapper',
368 Note that any configuration items defined by one of the earlier
369 methods will be overwritten by items of the same name provided by the
372 =head2 DYNAMIC INCLUDE_PATH
374 Sometimes it is desirable to modify INCLUDE_PATH for your templates at run time.
376 Additional paths can be added to the start of INCLUDE_PATH via the stash as
379 $c->stash->{additional_template_paths} =
380 [$c->config->{root} . '/test_include_path'];
382 If you need to add paths to the end of INCLUDE_PATH, there is also an
383 include_path() accessor available:
385 push( @{ $c->view('TT')->include_path }, qw/path/ );
387 Note that if you use include_path() to add extra paths to INCLUDE_PATH, you
388 MUST check for duplicate paths. Without such checking, the above code will add
389 "path" to INCLUDE_PATH at every request, causing a memory leak.
391 A safer approach is to use include_path() to overwrite the array of paths
392 rather than adding to it. This eliminates both the need to perform duplicate
393 checking and the chance of a memory leak:
395 @{ $c->view('TT')->include_path } = qw/path another_path/;
397 If you are calling C<render> directly then you can specify dynamic paths by
398 having a C<additional_template_paths> key with a value of additonal directories
399 to search. See L<CAPTURING TEMPLATE OUTPUT> for an example showing this.
401 =head2 RENDERING VIEWS
403 The view plugin renders the template specified in the C<template>
406 sub message : Global {
407 my ( $self, $c ) = @_;
408 $c->stash->{template} = 'message.tt2';
409 $c->forward( $c->view('TT') );
412 If a stash item isn't defined, then it instead uses the
413 stringification of the action dispatched to (as defined by $c->action)
414 in the above example, this would be C<message>, but because the default
415 is to append '.tt', it would load C<root/message.tt>.
417 The items defined in the stash are passed to the Template Toolkit for
418 use as template variables.
420 sub default : Private {
421 my ( $self, $c ) = @_;
422 $c->stash->{template} = 'message.tt2';
423 $c->stash->{message} = 'Hello World!';
424 $c->forward( $c->view('TT') );
427 A number of other template variables are also added:
429 c A reference to the context object, $c
430 base The URL base, from $c->req->base()
431 name The application name, from $c->config->{ name }
433 These can be accessed from the template in the usual way:
437 The message is: [% message %]
438 The base is [% base %]
439 The name is [% name %]
442 The output generated by the template is stored in C<< $c->response->body >>.
444 =head2 CAPTURING TEMPLATE OUTPUT
446 If you wish to use the output of a template for some other purpose than
447 displaying in the response, e.g. for sending an email, this is possible using
448 L<Catalyst::Plugin::Email> and the L<render> method:
450 sub send_email : Local {
455 To => 'me@localhost',
456 Subject => 'A TT Email',
458 body => $c->view('TT')->render($c, 'email.tt', {
459 additional_template_paths => [ $c->config->{root} . '/email_templates'],
460 email_tmpl_param1 => 'foo'
464 # Redirect or display a message
467 =head2 TEMPLATE PROFILING
469 See L<C<TIMER>> property of the L<config> method.
475 The constructor for the TT view. Sets up the template provider,
476 and reads the application config.
480 Renders the template specified in C<< $c->stash->{template} >> or
481 C<< $c->action >> (the private name of the matched action). Calls L<render> to
482 perform actual rendering. Output is stored in C<< $c->response->body >>.
484 It is possible to forward to the process method of a TT view from inside
487 $c->forward('View::TT');
489 N.B. This is usually done automatically by L<Catalyst::Action::RenderView>.
491 =head2 render($c, $template, \%args)
493 Renders the given template and returns output. Throws a L<Template::Exception>
496 The template variables are set to C<%$args> if $args is a hashref, or
497 $C<< $c->stash >> otherwise. In either case the variables are augmented with
498 C<base> set to C< << $c->req->base >>, C<c> to C<$c> and C<name> to
499 C<< $c->config->{name} >>. Alternately, the C<CATALYST_VAR> configuration item
500 can be defined to specify the name of a template variable through which the
501 context reference (C<$c>) can be accessed. In this case, the C<c>, C<base> and
502 C<name> variables are omitted.
504 C<$template> can be anything that Template::process understands how to
505 process, including the name of a template file or a reference to a test string.
506 See L<Template::process|Template/process> for a full list of supported formats.
508 To use the render method outside of your Catalyst app, just pass a undef context.
509 This can be useful for tests, for instance.
511 It is possible to forward to the render method of a TT view from inside Catalyst
512 to render page fragments like this:
514 my $fragment = $c->forward("View::TT", "render", $template_name, $c->stash->{fragment_data});
518 Returns a list of keys/values to be used as the catalyst variables in the
523 This method allows your view subclass to pass additional settings to
524 the TT configuration hash, or to set the options as below:
528 The list of paths TT will look for templates in.
530 =head2 C<CATALYST_VAR>
532 Allows you to change the name of the Catalyst context object. If set, it will also
533 remove the base and name aliases, so you will have access them through <context>.
539 root => MyApp->path_to('root'),
541 CATALYST_VAR => 'Catalyst',
547 The base is [% Catalyst.req.base %]
548 The name is [% Catalyst.config.name %]
552 If you have configured Catalyst for debug output, and turned on the TIMER setting,
553 C<Catalyst::View::TT> will enable profiling of template processing
554 (using L<Template::Timer>). This will embed HTML comments in the
555 output from your templates, such as:
557 <!-- TIMER START: process mainmenu/mainmenu.ttml -->
558 <!-- TIMER START: include mainmenu/cssindex.tt -->
559 <!-- TIMER START: process mainmenu/cssindex.tt -->
560 <!-- TIMER END: process mainmenu/cssindex.tt (0.017279 seconds) -->
561 <!-- TIMER END: include mainmenu/cssindex.tt (0.017401 seconds) -->
565 <!-- TIMER END: process mainmenu/footer.tt (0.003016 seconds) -->
568 =head2 C<TEMPLATE_EXTENSION>
570 a sufix to add when looking for templates bases on the C<match> method in L<Catalyst::Request>.
574 package MyApp::Controller::Test;
575 sub test : Local { .. }
577 Would by default look for a template in <root>/test/test. If you set TEMPLATE_EXTENSION to '.tt', it will look for
582 Allows you to specify the template providers that TT will use.
586 root => MyApp->path_to('root'),
592 DBI_DSN => 'dbi:DB2:books',
603 The 'name' key should correspond to the class name of the provider you
604 want to use. The _file_ name is a special case that represents the default
605 TT file-based provider. By default the name is will be prefixed with
606 'Template::Provider::'. You can fully qualify the name by using a unary
609 name => '+MyApp::Provider::Foo'
611 You can also specify the 'copy_config' key as an arrayref, to copy those keys
612 from the general config, into the config for the provider:
614 DEFAULT_ENCODING => 'utf-8',
618 copy_config => [qw(DEFAULT_ENCODING INCLUDE_PATH)]
622 This can prove useful when you want to use the additional_template_paths hack
623 in your own provider, or if you need to use Template::Provider::Encoding
627 The L<Catalyst::Helper::View::TT> and
628 L<Catalyst::Helper::View::TTSite> helper modules are provided to create
629 your view module. There are invoked by the F<myapp_create.pl> script:
631 $ script/myapp_create.pl view TT TT
633 $ script/myapp_create.pl view TT TTSite
635 The L<Catalyst::Helper::View::TT> module creates a basic TT view
636 module. The L<Catalyst::Helper::View::TTSite> module goes a little
637 further. It also creates a default set of templates to get you
638 started. It also configures the view module to locate the templates
643 If you are using the L<CGI> module inside your templates, you will
644 experience that the Catalyst server appears to hang while rendering
645 the web page. This is due to the debug mode of L<CGI> (which is
646 waiting for input in the terminal window). Turning off the
647 debug mode using the "-no_debug" option solves the
650 [% USE CGI('-no_debug') %]
654 L<Catalyst>, L<Catalyst::Helper::View::TT>,
655 L<Catalyst::Helper::View::TTSite>, L<Template::Manual>
659 Sebastian Riedel, C<sri@cpan.org>
661 Marcus Ramberg, C<mramberg@cpan.org>
663 Jesse Sheidlower, C<jester@panix.com>
665 Andy Wardley, C<abw@cpan.org>
669 This program is free software. You can redistribute it and/or modify it
670 under the same terms as Perl itself.