1 package Catalyst::View::TT;
6 use base qw/Catalyst::View/;
12 our $VERSION = '0.33';
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'),
36 # any TT configurations items go here
38 MyApp->path_to( 'root', 'src' ),
39 MyApp->path_to( 'root', 'lib' ),
41 TEMPLATE_EXTENSION => '.tt',
45 PRE_PROCESS => 'config/main',
46 WRAPPER => 'site/wrapper',
47 render_die => 1, # Default for new apps, see render method docs
51 # render view from lib/MyApp.pm or lib/MyApp::Controller::SomeController.pm
53 sub message : Global {
54 my ( $self, $c ) = @_;
55 $c->stash->{template} = 'message.tt2';
56 $c->stash->{message} = 'Hello World!';
57 $c->forward( $c->view('TT') );
60 # access variables from template
62 The message is: [% message %].
64 # example when CATALYST_VAR is set to 'Catalyst'
65 Context is [% Catalyst %]
66 The base is [% Catalyst.req.base %]
67 The name is [% Catalyst.config.name %]
69 # example when CATALYST_VAR isn't set
71 The base is [% base %]
72 The name is [% name %]
77 my ( $paths, $dlim ) = shift;
78 return () if ( !$paths );
79 return @{$paths} if ( ref $paths eq 'ARRAY' );
81 # tweak delim to ignore C:/
82 unless ( defined $dlim ) {
83 $dlim = ( $^O eq 'MSWin32' ) ? ':(?!\\/)' : ':';
85 return split( /$dlim/, $paths );
89 my ( $class, $c, $arguments ) = @_;
92 TEMPLATE_EXTENSION => '',
96 if ( ! (ref $config->{INCLUDE_PATH} eq 'ARRAY') ) {
97 my $delim = $config->{DELIMITER};
99 = _coerce_paths( $config->{INCLUDE_PATH}, $delim );
100 if ( !@include_path ) {
101 my $root = $c->config->{root};
102 my $base = Path::Class::dir( $root, 'base' );
103 @include_path = ( "$root", "$base" );
105 $config->{INCLUDE_PATH} = \@include_path;
108 # if we're debugging and/or the TIMER option is set, then we install
109 # Template::Timer as a custom CONTEXT object, but only if we haven't
110 # already got a custom CONTEXT defined
112 if ( $config->{TIMER} ) {
113 if ( $config->{CONTEXT} ) {
115 'Cannot use Template::Timer - a TT CONTEXT is already defined'
119 $config->{CONTEXT} = Template::Timer->new(%$config);
123 if ( $c->debug && $config->{DUMP_CONFIG} ) {
124 $c->log->debug( "TT Config: ", dump($config) );
127 my $self = $class->next::method(
131 # Set base include paths. Local'd in render if needed
132 $self->include_path($config->{INCLUDE_PATH});
134 $self->config($config);
136 # Creation of template outside of call to new so that we can pass [ $self ]
137 # as INCLUDE_PATH config item, which then gets ->paths() called to get list
138 # of include paths to search for templates.
140 # Use a weakend copy of self so we dont have loops preventing GC from working
142 Scalar::Util::weaken($copy);
143 $config->{INCLUDE_PATH} = [ sub { $copy->paths } ];
145 if ( $config->{PROVIDERS} ) {
147 if ( ref($config->{PROVIDERS}) eq 'ARRAY') {
148 foreach my $p (@{$config->{PROVIDERS}}) {
149 my $pname = $p->{name};
150 my $prov = 'Template::Provider';
151 if($pname eq '_file_')
153 $p->{args} = { %$config };
157 if($pname =~ s/^\+//) {
164 # We copy the args people want from the config
167 if ($p->{copy_config}) {
168 map { $p->{args}->{$_} = $config->{$_} }
169 grep { exists $config->{$_} }
170 @{ $p->{copy_config} };
174 eval "require $prov";
176 push @providers, "$prov"->new($p->{args});
180 $c->log->warn("Can't load $prov, ($@)");
184 delete $config->{PROVIDERS};
186 $config->{LOAD_TEMPLATES} = \@providers;
191 Template->new($config) || do {
192 my $error = Template->error();
193 $c->log->error($error);
203 my ( $self, $c ) = @_;
205 my $template = $c->stash->{template}
206 || $c->action . $self->config->{TEMPLATE_EXTENSION};
208 unless (defined $template) {
209 $c->log->debug('No template specified for rendering') if $c->debug;
214 my $output = eval { $self->render($c, $template) };
216 my $error = qq/Couldn't render template "$template"/;
217 $c->log->error($error);
222 unless ( $c->response->content_type ) {
223 $c->response->content_type('text/html; charset=utf-8');
226 $c->response->body($output);
232 my ($self, $c, $template, $args) = @_;
234 $c->log->debug(qq/Rendering template "$template"/) if $c && $c->debug;
238 (ref $args eq 'HASH' ? %$args : %{ $c->stash() }),
239 $self->template_vars($c)
242 local $self->{include_path} =
243 [ @{ $vars->{additional_template_paths} }, @{ $self->{include_path} } ]
244 if ref $vars->{additional_template_paths};
246 unless ( $self->template->process( $template, $vars, \$output ) ) {
247 if (exists $self->{render_die}) {
248 die $self->template->error if $self->{render_die};
249 return $self->template->error;
252 Carp::carp('The Catalyst::View::TT render() method of will die on error in a future release. If you want it to continue to return the exception instead, pass render_die => 0 to the constructor');
253 return $self->template->error;
259 my ( $self, $c ) = @_;
262 my $cvar = $self->config->{CATALYST_VAR};
268 base => $c->req->base,
269 name => $c->config->{name}
280 This is the Catalyst view class for the L<Template Toolkit|Template>.
281 Your application should defined a view class which is a subclass of
282 this module. The easiest way to achieve this is using the
283 F<myapp_create.pl> script (where F<myapp> should be replaced with
284 whatever your application is called). This script is created as part
285 of the Catalyst setup.
287 $ script/myapp_create.pl view TT TT
289 This creates a MyApp::View::TT.pm module in the F<lib> directory (again,
290 replacing C<MyApp> with the name of your application) which looks
293 package FooBar::View::TT;
298 use base 'Catalyst::View::TT';
300 __PACKAGE__->config(DEBUG => 'all');
302 Now you can modify your action handlers in the main application and/or
303 controllers to forward to your view class. You might choose to do this
304 in the end() method, for example, to automatically forward all actions
305 to the TT view class.
307 # In MyApp or MyApp::Controller::SomeController
310 my( $self, $c ) = @_;
311 $c->forward( $c->view('TT') );
314 But if you are using the standard auto-generated end action, you don't even need
317 # in MyApp::Controller::Root
318 sub end : ActionClass('RenderView') {} # no need to change this line
323 default_view => 'TT',
326 This will Just Work. And it has the advantages that:
332 If you want to use a different view for a given request, just set
333 << $c->stash->{current_view} >>. (See L<Catalyst>'s C<< $c->view >> method
338 << $c->res->redirect >> is handled by default. If you just forward to
339 C<View::TT> in your C<end> routine, you could break this by sending additional
344 See L<Catalyst::Action::RenderView> for more details.
348 There are a three different ways to configure your view class. The
349 first way is to call the C<config()> method in the view subclass. This
350 happens when the module is first loaded.
352 package MyApp::View::TT;
355 use base 'Catalyst::View::TT';
357 MyApp::View::TT->config({
359 MyApp->path_to( 'root', 'templates', 'lib' ),
360 MyApp->path_to( 'root', 'templates', 'src' ),
362 PRE_PROCESS => 'config/main',
363 WRAPPER => 'site/wrapper',
366 The second way is to define a C<new()> method in your view subclass.
367 This performs the configuration when the view object is created,
368 shortly after being loaded. Remember to delegate to the base class
369 C<new()> method (via C<$self-E<gt>next::method()> in the example below) after
370 performing any configuration.
376 MyApp->path_to( 'root', 'templates', 'lib' ),
377 MyApp->path_to( 'root', 'templates', 'src' ),
379 PRE_PROCESS => 'config/main',
380 WRAPPER => 'site/wrapper',
382 return $self->next::method(@_);
385 The final, and perhaps most direct way, is to define a class
386 item in your main application configuration, again by calling the
387 ubiquitous C<config()> method. The items in the class hash are
388 added to those already defined by the above two methods. This happens
389 in the base class new() method (which is one reason why you must
390 remember to call it via C<MRO::Compat> if you redefine the C<new()>
391 method in a subclass).
400 root => MyApp->path_to('root'),
403 MyApp->path_to( 'root', 'templates', 'lib' ),
404 MyApp->path_to( 'root', 'templates', 'src' ),
406 PRE_PROCESS => 'config/main',
407 WRAPPER => 'site/wrapper',
411 Note that any configuration items defined by one of the earlier
412 methods will be overwritten by items of the same name provided by the
415 =head2 DYNAMIC INCLUDE_PATH
417 Sometimes it is desirable to modify INCLUDE_PATH for your templates at run time.
419 Additional paths can be added to the start of INCLUDE_PATH via the stash as
422 $c->stash->{additional_template_paths} =
423 [$c->config->{root} . '/test_include_path'];
425 If you need to add paths to the end of INCLUDE_PATH, there is also an
426 include_path() accessor available:
428 push( @{ $c->view('TT')->include_path }, qw/path/ );
430 Note that if you use include_path() to add extra paths to INCLUDE_PATH, you
431 MUST check for duplicate paths. Without such checking, the above code will add
432 "path" to INCLUDE_PATH at every request, causing a memory leak.
434 A safer approach is to use include_path() to overwrite the array of paths
435 rather than adding to it. This eliminates both the need to perform duplicate
436 checking and the chance of a memory leak:
438 @{ $c->view('TT')->include_path } = qw/path another_path/;
440 If you are calling C<render> directly then you can specify dynamic paths by
441 having a C<additional_template_paths> key with a value of additonal directories
442 to search. See L<CAPTURING TEMPLATE OUTPUT> for an example showing this.
444 =head2 RENDERING VIEWS
446 The view plugin renders the template specified in the C<template>
449 sub message : Global {
450 my ( $self, $c ) = @_;
451 $c->stash->{template} = 'message.tt2';
452 $c->forward( $c->view('TT') );
455 If a stash item isn't defined, then it instead uses the
456 stringification of the action dispatched to (as defined by $c->action)
457 in the above example, this would be C<message>, but because the default
458 is to append '.tt', it would load C<root/message.tt>.
460 The items defined in the stash are passed to the Template Toolkit for
461 use as template variables.
463 sub default : Private {
464 my ( $self, $c ) = @_;
465 $c->stash->{template} = 'message.tt2';
466 $c->stash->{message} = 'Hello World!';
467 $c->forward( $c->view('TT') );
470 A number of other template variables are also added:
472 c A reference to the context object, $c
473 base The URL base, from $c->req->base()
474 name The application name, from $c->config->{ name }
476 These can be accessed from the template in the usual way:
480 The message is: [% message %]
481 The base is [% base %]
482 The name is [% name %]
485 The output generated by the template is stored in C<< $c->response->body >>.
487 =head2 CAPTURING TEMPLATE OUTPUT
489 If you wish to use the output of a template for some other purpose than
490 displaying in the response, e.g. for sending an email, this is possible using
491 L<Catalyst::Plugin::Email> and the L<render> method:
493 sub send_email : Local {
498 To => 'me@localhost',
499 Subject => 'A TT Email',
501 body => $c->view('TT')->render($c, 'email.tt', {
502 additional_template_paths => [ $c->config->{root} . '/email_templates'],
503 email_tmpl_param1 => 'foo'
507 # Redirect or display a message
510 =head2 TEMPLATE PROFILING
512 See L<C<TIMER>> property of the L<config> method.
518 The constructor for the TT view. Sets up the template provider,
519 and reads the application config.
523 Renders the template specified in C<< $c->stash->{template} >> or
524 C<< $c->action >> (the private name of the matched action). Calls L<render> to
525 perform actual rendering. Output is stored in C<< $c->response->body >>.
527 It is possible to forward to the process method of a TT view from inside
530 $c->forward('View::TT');
532 N.B. This is usually done automatically by L<Catalyst::Action::RenderView>.
534 =head2 render($c, $template, \%args)
536 Renders the given template and returns output. Throws a L<Template::Exception>
539 The template variables are set to C<%$args> if $args is a hashref, or
540 $C<< $c->stash >> otherwise. In either case the variables are augmented with
541 C<base> set to C< << $c->req->base >>, C<c> to C<$c> and C<name> to
542 C<< $c->config->{name} >>. Alternately, the C<CATALYST_VAR> configuration item
543 can be defined to specify the name of a template variable through which the
544 context reference (C<$c>) can be accessed. In this case, the C<c>, C<base> and
545 C<name> variables are omitted.
547 C<$template> can be anything that Template::process understands how to
548 process, including the name of a template file or a reference to a test string.
549 See L<Template::process|Template/process> for a full list of supported formats.
551 To use the render method outside of your Catalyst app, just pass a undef context.
552 This can be useful for tests, for instance.
554 It is possible to forward to the render method of a TT view from inside Catalyst
555 to render page fragments like this:
557 my $fragment = $c->forward("View::TT", "render", $template_name, $c->stash->{fragment_data});
559 =head3 Backwards compatibility note
561 The render method used to just return the Template::Exception object, rather
562 than just throwing it. This is now deprecated and instead the render method
563 will throw an exception for new applications.
565 This behaviour can be activated (and is activated in the default skeleton
566 configuration) by using C<< render_die => 1 >>. If you rely on the legacy
567 behaviour then a warning will be issued.
569 To silence this warning, set C<< render_die => 0 >>, but it is recommended
570 you adjust your code so that it works with C<< render_die => 1 >>.
572 In a future release, C<< render_die => 1 >> will become the default if
577 Returns a list of keys/values to be used as the catalyst variables in the
582 This method allows your view subclass to pass additional settings to
583 the TT configuration hash, or to set the options as below:
587 The list of paths TT will look for templates in.
589 =head2 C<CATALYST_VAR>
591 Allows you to change the name of the Catalyst context object. If set, it will also
592 remove the base and name aliases, so you will have access them through <context>.
598 root => MyApp->path_to('root'),
600 CATALYST_VAR => 'Catalyst',
606 The base is [% Catalyst.req.base %]
607 The name is [% Catalyst.config.name %]
611 If you have configured Catalyst for debug output, and turned on the TIMER setting,
612 C<Catalyst::View::TT> will enable profiling of template processing
613 (using L<Template::Timer>). This will embed HTML comments in the
614 output from your templates, such as:
616 <!-- TIMER START: process mainmenu/mainmenu.ttml -->
617 <!-- TIMER START: include mainmenu/cssindex.tt -->
618 <!-- TIMER START: process mainmenu/cssindex.tt -->
619 <!-- TIMER END: process mainmenu/cssindex.tt (0.017279 seconds) -->
620 <!-- TIMER END: include mainmenu/cssindex.tt (0.017401 seconds) -->
624 <!-- TIMER END: process mainmenu/footer.tt (0.003016 seconds) -->
627 =head2 C<TEMPLATE_EXTENSION>
629 a sufix to add when looking for templates bases on the C<match> method in L<Catalyst::Request>.
633 package MyApp::Controller::Test;
634 sub test : Local { .. }
636 Would by default look for a template in <root>/test/test. If you set TEMPLATE_EXTENSION to '.tt', it will look for
641 Allows you to specify the template providers that TT will use.
645 root => MyApp->path_to('root'),
651 DBI_DSN => 'dbi:DB2:books',
662 The 'name' key should correspond to the class name of the provider you
663 want to use. The _file_ name is a special case that represents the default
664 TT file-based provider. By default the name is will be prefixed with
665 'Template::Provider::'. You can fully qualify the name by using a unary
668 name => '+MyApp::Provider::Foo'
670 You can also specify the 'copy_config' key as an arrayref, to copy those keys
671 from the general config, into the config for the provider:
673 DEFAULT_ENCODING => 'utf-8',
677 copy_config => [qw(DEFAULT_ENCODING INCLUDE_PATH)]
681 This can prove useful when you want to use the additional_template_paths hack
682 in your own provider, or if you need to use Template::Provider::Encoding
686 The L<Catalyst::Helper::View::TT> and
687 L<Catalyst::Helper::View::TTSite> helper modules are provided to create
688 your view module. There are invoked by the F<myapp_create.pl> script:
690 $ script/myapp_create.pl view TT TT
692 $ script/myapp_create.pl view TT TTSite
694 The L<Catalyst::Helper::View::TT> module creates a basic TT view
695 module. The L<Catalyst::Helper::View::TTSite> module goes a little
696 further. It also creates a default set of templates to get you
697 started. It also configures the view module to locate the templates
702 If you are using the L<CGI> module inside your templates, you will
703 experience that the Catalyst server appears to hang while rendering
704 the web page. This is due to the debug mode of L<CGI> (which is
705 waiting for input in the terminal window). Turning off the
706 debug mode using the "-no_debug" option solves the
709 [% USE CGI('-no_debug') %]
713 L<Catalyst>, L<Catalyst::Helper::View::TT>,
714 L<Catalyst::Helper::View::TTSite>, L<Template::Manual>
718 Sebastian Riedel, C<sri@cpan.org>
720 Marcus Ramberg, C<mramberg@cpan.org>
722 Jesse Sheidlower, C<jester@panix.com>
724 Andy Wardley, C<abw@cpan.org>
728 This program is free software. You can redistribute it and/or modify it
729 under the same terms as Perl itself.