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'),
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',
46 render_die => 1, # Default for new apps, see render method docs
50 # render view from lib/MyApp.pm or lib/MyApp::Controller::SomeController.pm
52 sub message : Global {
53 my ( $self, $c ) = @_;
54 $c->stash->{template} = 'message.tt2';
55 $c->stash->{message} = 'Hello World!';
56 $c->forward( $c->view('TT') );
59 # access variables from template
61 The message is: [% message %].
63 # example when CATALYST_VAR is set to 'Catalyst'
64 Context is [% Catalyst %]
65 The base is [% Catalyst.req.base %]
66 The name is [% Catalyst.config.name %]
68 # example when CATALYST_VAR isn't set
70 The base is [% base %]
71 The name is [% name %]
76 my ( $paths, $dlim ) = shift;
77 return () if ( !$paths );
78 return @{$paths} if ( ref $paths eq 'ARRAY' );
80 # tweak delim to ignore C:/
81 unless ( defined $dlim ) {
82 $dlim = ( $^O eq 'MSWin32' ) ? ':(?!\\/)' : ':';
84 return split( /$dlim/, $paths );
88 my ( $class, $c, $arguments ) = @_;
91 TEMPLATE_EXTENSION => '',
95 if ( ! (ref $config->{INCLUDE_PATH} eq 'ARRAY') ) {
96 my $delim = $config->{DELIMITER};
98 = _coerce_paths( $config->{INCLUDE_PATH}, $delim );
99 if ( !@include_path ) {
100 my $root = $c->config->{root};
101 my $base = Path::Class::dir( $root, 'base' );
102 @include_path = ( "$root", "$base" );
104 $config->{INCLUDE_PATH} = \@include_path;
107 # if we're debugging and/or the TIMER option is set, then we install
108 # Template::Timer as a custom CONTEXT object, but only if we haven't
109 # already got a custom CONTEXT defined
111 if ( $config->{TIMER} ) {
112 if ( $config->{CONTEXT} ) {
114 'Cannot use Template::Timer - a TT CONTEXT is already defined'
118 $config->{CONTEXT} = Template::Timer->new(%$config);
122 if ( $c->debug && $config->{DUMP_CONFIG} ) {
123 $c->log->debug( "TT Config: ", dump($config) );
126 my $self = $class->next::method(
130 # Set base include paths. Local'd in render if needed
131 $self->include_path($config->{INCLUDE_PATH});
133 $self->config($config);
135 # Creation of template outside of call to new so that we can pass [ $self ]
136 # as INCLUDE_PATH config item, which then gets ->paths() called to get list
137 # of include paths to search for templates.
139 # Use a weakend copy of self so we dont have loops preventing GC from working
141 Scalar::Util::weaken($copy);
142 $config->{INCLUDE_PATH} = [ sub { $copy->paths } ];
144 if ( $config->{PROVIDERS} ) {
146 if ( ref($config->{PROVIDERS}) eq 'ARRAY') {
147 foreach my $p (@{$config->{PROVIDERS}}) {
148 my $pname = $p->{name};
149 my $prov = 'Template::Provider';
150 if($pname eq '_file_')
152 $p->{args} = { %$config };
156 if($pname =~ s/^\+//) {
163 # We copy the args people want from the config
166 if ($p->{copy_config}) {
167 map { $p->{args}->{$_} = $config->{$_} }
168 grep { exists $config->{$_} }
169 @{ $p->{copy_config} };
173 eval "require $prov";
175 push @providers, "$prov"->new($p->{args});
179 $c->log->warn("Can't load $prov, ($@)");
183 delete $config->{PROVIDERS};
185 $config->{LOAD_TEMPLATES} = \@providers;
190 Template->new($config) || do {
191 my $error = Template->error();
192 $c->log->error($error);
202 my ( $self, $c ) = @_;
204 my $template = $c->stash->{template}
205 || $c->action . $self->config->{TEMPLATE_EXTENSION};
207 unless (defined $template) {
208 $c->log->debug('No template specified for rendering') if $c->debug;
213 my $output = eval { $self->render($c, $template) };
215 my $error = qq/Couldn't render template "$template"/;
216 $c->log->error($error);
221 unless ( $c->response->content_type ) {
222 $c->response->content_type('text/html; charset=utf-8');
225 $c->response->body($output);
231 my ($self, $c, $template, $args) = @_;
233 $c->log->debug(qq/Rendering template "$template"/) if $c && $c->debug;
237 (ref $args eq 'HASH' ? %$args : %{ $c->stash() }),
238 $self->template_vars($c)
241 local $self->{include_path} =
242 [ @{ $vars->{additional_template_paths} }, @{ $self->{include_path} } ]
243 if ref $vars->{additional_template_paths};
245 unless ( $self->template->process( $template, $vars, \$output ) ) {
246 if (exists $self->{render_die}) {
247 die $self->template->error if $self->{render_die};
248 return $self->template->error;
251 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');
252 return $self->template->error;
258 my ( $self, $c ) = @_;
261 my $cvar = $self->config->{CATALYST_VAR};
267 base => $c->req->base,
268 name => $c->config->{name}
279 This is the Catalyst view class for the L<Template Toolkit|Template>.
280 Your application should defined a view class which is a subclass of
281 this module. The easiest way to achieve this is using the
282 F<myapp_create.pl> script (where F<myapp> should be replaced with
283 whatever your application is called). This script is created as part
284 of the Catalyst setup.
286 $ script/myapp_create.pl view TT TT
288 This creates a MyApp::View::TT.pm module in the F<lib> directory (again,
289 replacing C<MyApp> with the name of your application) which looks
292 package FooBar::View::TT;
297 use base 'Catalyst::View::TT';
299 __PACKAGE__->config(DEBUG => 'all');
301 Now you can modify your action handlers in the main application and/or
302 controllers to forward to your view class. You might choose to do this
303 in the end() method, for example, to automatically forward all actions
304 to the TT view class.
306 # In MyApp or MyApp::Controller::SomeController
309 my( $self, $c ) = @_;
310 $c->forward( $c->view('TT') );
313 But if you are using the standard auto-generated end action, you don't even need
316 # in MyApp::Controller::Root
317 sub end : ActionClass('RenderView') {} # no need to change this line
322 default_view => 'TT',
325 This will Just Work. And it has the advantages that:
331 If you want to use a different view for a given request, just set
332 << $c->stash->{current_view} >>. (See L<Catalyst>'s C<< $c->view >> method
337 << $c->res->redirect >> is handled by default. If you just forward to
338 C<View::TT> in your C<end> routine, you could break this by sending additional
343 See L<Catalyst::Action::RenderView> for more details.
347 There are a three different ways to configure your view class. The
348 first way is to call the C<config()> method in the view subclass. This
349 happens when the module is first loaded.
351 package MyApp::View::TT;
354 use base 'Catalyst::View::TT';
356 MyApp::View::TT->config({
358 MyApp->path_to( 'root', 'templates', 'lib' ),
359 MyApp->path_to( 'root', 'templates', 'src' ),
361 PRE_PROCESS => 'config/main',
362 WRAPPER => 'site/wrapper',
365 The second way is to define a C<new()> method in your view subclass.
366 This performs the configuration when the view object is created,
367 shortly after being loaded. Remember to delegate to the base class
368 C<new()> method (via C<$self-E<gt>next::method()> in the example below) after
369 performing any configuration.
375 MyApp->path_to( 'root', 'templates', 'lib' ),
376 MyApp->path_to( 'root', 'templates', 'src' ),
378 PRE_PROCESS => 'config/main',
379 WRAPPER => 'site/wrapper',
381 return $self->next::method(@_);
384 The final, and perhaps most direct way, is to define a class
385 item in your main application configuration, again by calling the
386 ubiquitous C<config()> method. The items in the class hash are
387 added to those already defined by the above two methods. This happens
388 in the base class new() method (which is one reason why you must
389 remember to call it via C<MRO::Compat> if you redefine the C<new()>
390 method in a subclass).
399 root => MyApp->path_to('root'),
402 MyApp->path_to( 'root', 'templates', 'lib' ),
403 MyApp->path_to( 'root', 'templates', 'src' ),
405 PRE_PROCESS => 'config/main',
406 WRAPPER => 'site/wrapper',
410 Note that any configuration items defined by one of the earlier
411 methods will be overwritten by items of the same name provided by the
414 =head2 DYNAMIC INCLUDE_PATH
416 Sometimes it is desirable to modify INCLUDE_PATH for your templates at run time.
418 Additional paths can be added to the start of INCLUDE_PATH via the stash as
421 $c->stash->{additional_template_paths} =
422 [$c->config->{root} . '/test_include_path'];
424 If you need to add paths to the end of INCLUDE_PATH, there is also an
425 include_path() accessor available:
427 push( @{ $c->view('TT')->include_path }, qw/path/ );
429 Note that if you use include_path() to add extra paths to INCLUDE_PATH, you
430 MUST check for duplicate paths. Without such checking, the above code will add
431 "path" to INCLUDE_PATH at every request, causing a memory leak.
433 A safer approach is to use include_path() to overwrite the array of paths
434 rather than adding to it. This eliminates both the need to perform duplicate
435 checking and the chance of a memory leak:
437 @{ $c->view('TT')->include_path } = qw/path another_path/;
439 If you are calling C<render> directly then you can specify dynamic paths by
440 having a C<additional_template_paths> key with a value of additonal directories
441 to search. See L<CAPTURING TEMPLATE OUTPUT> for an example showing this.
443 =head2 RENDERING VIEWS
445 The view plugin renders the template specified in the C<template>
448 sub message : Global {
449 my ( $self, $c ) = @_;
450 $c->stash->{template} = 'message.tt2';
451 $c->forward( $c->view('TT') );
454 If a stash item isn't defined, then it instead uses the
455 stringification of the action dispatched to (as defined by $c->action)
456 in the above example, this would be C<message>, but because the default
457 is to append '.tt', it would load C<root/message.tt>.
459 The items defined in the stash are passed to the Template Toolkit for
460 use as template variables.
462 sub default : Private {
463 my ( $self, $c ) = @_;
464 $c->stash->{template} = 'message.tt2';
465 $c->stash->{message} = 'Hello World!';
466 $c->forward( $c->view('TT') );
469 A number of other template variables are also added:
471 c A reference to the context object, $c
472 base The URL base, from $c->req->base()
473 name The application name, from $c->config->{ name }
475 These can be accessed from the template in the usual way:
479 The message is: [% message %]
480 The base is [% base %]
481 The name is [% name %]
484 The output generated by the template is stored in C<< $c->response->body >>.
486 =head2 CAPTURING TEMPLATE OUTPUT
488 If you wish to use the output of a template for some other purpose than
489 displaying in the response, e.g. for sending an email, this is possible using
490 L<Catalyst::Plugin::Email> and the L<render> method:
492 sub send_email : Local {
497 To => 'me@localhost',
498 Subject => 'A TT Email',
500 body => $c->view('TT')->render($c, 'email.tt', {
501 additional_template_paths => [ $c->config->{root} . '/email_templates'],
502 email_tmpl_param1 => 'foo'
506 # Redirect or display a message
509 =head2 TEMPLATE PROFILING
511 See L<C<TIMER>> property of the L<config> method.
517 The constructor for the TT view. Sets up the template provider,
518 and reads the application config.
522 Renders the template specified in C<< $c->stash->{template} >> or
523 C<< $c->action >> (the private name of the matched action). Calls L<render> to
524 perform actual rendering. Output is stored in C<< $c->response->body >>.
526 It is possible to forward to the process method of a TT view from inside
529 $c->forward('View::TT');
531 N.B. This is usually done automatically by L<Catalyst::Action::RenderView>.
533 =head2 render($c, $template, \%args)
535 Renders the given template and returns output. Throws a L<Template::Exception>
538 The template variables are set to C<%$args> if $args is a hashref, or
539 $C<< $c->stash >> otherwise. In either case the variables are augmented with
540 C<base> set to C< << $c->req->base >>, C<c> to C<$c> and C<name> to
541 C<< $c->config->{name} >>. Alternately, the C<CATALYST_VAR> configuration item
542 can be defined to specify the name of a template variable through which the
543 context reference (C<$c>) can be accessed. In this case, the C<c>, C<base> and
544 C<name> variables are omitted.
546 C<$template> can be anything that Template::process understands how to
547 process, including the name of a template file or a reference to a test string.
548 See L<Template::process|Template/process> for a full list of supported formats.
550 To use the render method outside of your Catalyst app, just pass a undef context.
551 This can be useful for tests, for instance.
553 It is possible to forward to the render method of a TT view from inside Catalyst
554 to render page fragments like this:
556 my $fragment = $c->forward("View::TT", "render", $template_name, $c->stash->{fragment_data});
558 =head3 Backwards compatibility note
560 The render method used to just return the Template::Exception object, rather
561 than just throwing it. This is now deprecated and instead the render method
562 will throw an exception for new applications.
564 This behaviour can be activated (and is activated in the default skeleton
565 configuration) by using C<< render_die => 1 >>. If you rely on the legacy
566 behaviour then a warning will be issued.
568 To silence this warning, set C<< render_die => 0 >>, but it is recommended
569 you adjust your code so that it works with C<< render_die => 1 >>.
571 In a future release, C<< render_die => 1 >> will become the default if
576 Returns a list of keys/values to be used as the catalyst variables in the
581 This method allows your view subclass to pass additional settings to
582 the TT configuration hash, or to set the options as below:
586 The list of paths TT will look for templates in.
588 =head2 C<CATALYST_VAR>
590 Allows you to change the name of the Catalyst context object. If set, it will also
591 remove the base and name aliases, so you will have access them through <context>.
597 root => MyApp->path_to('root'),
599 CATALYST_VAR => 'Catalyst',
605 The base is [% Catalyst.req.base %]
606 The name is [% Catalyst.config.name %]
610 If you have configured Catalyst for debug output, and turned on the TIMER setting,
611 C<Catalyst::View::TT> will enable profiling of template processing
612 (using L<Template::Timer>). This will embed HTML comments in the
613 output from your templates, such as:
615 <!-- TIMER START: process mainmenu/mainmenu.ttml -->
616 <!-- TIMER START: include mainmenu/cssindex.tt -->
617 <!-- TIMER START: process mainmenu/cssindex.tt -->
618 <!-- TIMER END: process mainmenu/cssindex.tt (0.017279 seconds) -->
619 <!-- TIMER END: include mainmenu/cssindex.tt (0.017401 seconds) -->
623 <!-- TIMER END: process mainmenu/footer.tt (0.003016 seconds) -->
626 =head2 C<TEMPLATE_EXTENSION>
628 a sufix to add when looking for templates bases on the C<match> method in L<Catalyst::Request>.
632 package MyApp::Controller::Test;
633 sub test : Local { .. }
635 Would by default look for a template in <root>/test/test. If you set TEMPLATE_EXTENSION to '.tt', it will look for
640 Allows you to specify the template providers that TT will use.
644 root => MyApp->path_to('root'),
650 DBI_DSN => 'dbi:DB2:books',
661 The 'name' key should correspond to the class name of the provider you
662 want to use. The _file_ name is a special case that represents the default
663 TT file-based provider. By default the name is will be prefixed with
664 'Template::Provider::'. You can fully qualify the name by using a unary
667 name => '+MyApp::Provider::Foo'
669 You can also specify the 'copy_config' key as an arrayref, to copy those keys
670 from the general config, into the config for the provider:
672 DEFAULT_ENCODING => 'utf-8',
676 copy_config => [qw(DEFAULT_ENCODING INCLUDE_PATH)]
680 This can prove useful when you want to use the additional_template_paths hack
681 in your own provider, or if you need to use Template::Provider::Encoding
685 The L<Catalyst::Helper::View::TT> and
686 L<Catalyst::Helper::View::TTSite> helper modules are provided to create
687 your view module. There are invoked by the F<myapp_create.pl> script:
689 $ script/myapp_create.pl view TT TT
691 $ script/myapp_create.pl view TT TTSite
693 The L<Catalyst::Helper::View::TT> module creates a basic TT view
694 module. The L<Catalyst::Helper::View::TTSite> module goes a little
695 further. It also creates a default set of templates to get you
696 started. It also configures the view module to locate the templates
701 If you are using the L<CGI> module inside your templates, you will
702 experience that the Catalyst server appears to hang while rendering
703 the web page. This is due to the debug mode of L<CGI> (which is
704 waiting for input in the terminal window). Turning off the
705 debug mode using the "-no_debug" option solves the
708 [% USE CGI('-no_debug') %]
712 L<Catalyst>, L<Catalyst::Helper::View::TT>,
713 L<Catalyst::Helper::View::TTSite>, L<Template::Manual>
717 Sebastian Riedel, C<sri@cpan.org>
719 Marcus Ramberg, C<mramberg@cpan.org>
721 Jesse Sheidlower, C<jester@panix.com>
723 Andy Wardley, C<abw@cpan.org>
727 This program is free software. You can redistribute it and/or modify it
728 under the same terms as Perl itself.