1 package Catalyst::View::TT;
6 use base qw/Catalyst::View/;
11 use Scalar::Util qw/blessed weaken/;
13 our $VERSION = '0.37';
14 $VERSION = eval $VERSION;
16 __PACKAGE__->mk_accessors('template');
17 __PACKAGE__->mk_accessors('expose_methods');
18 __PACKAGE__->mk_accessors('include_path');
20 *paths = \&include_path;
24 Catalyst::View::TT - Template View Class
28 # use the helper to create your View
30 myapp_create.pl view Web TT
32 # add custom configration in View/Web.pm
35 # any TT configuration 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
47 expose_methods => [qw/method_in_view_class/],
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('Web') );
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 => '',
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->expose_methods($config->{expose_methods});
135 $self->config($config);
137 # Creation of template outside of call to new so that we can pass [ $self ]
138 # as INCLUDE_PATH config item, which then gets ->paths() called to get list
139 # of include paths to search for templates.
141 # Use a weakend copy of self so we dont have loops preventing GC from working
143 Scalar::Util::weaken($copy);
144 $config->{INCLUDE_PATH} = [ sub { $copy->paths } ];
146 if ( $config->{PROVIDERS} ) {
148 if ( ref($config->{PROVIDERS}) eq 'ARRAY') {
149 foreach my $p (@{$config->{PROVIDERS}}) {
150 my $pname = $p->{name};
151 my $prov = 'Template::Provider';
152 if($pname eq '_file_')
154 $p->{args} = { %$config };
158 if($pname =~ s/^\+//) {
165 # We copy the args people want from the config
168 if ($p->{copy_config}) {
169 map { $p->{args}->{$_} = $config->{$_} }
170 grep { exists $config->{$_} }
171 @{ $p->{copy_config} };
175 eval "require $prov";
177 push @providers, "$prov"->new($p->{args});
181 $c->log->warn("Can't load $prov, ($@)");
185 delete $config->{PROVIDERS};
187 $config->{LOAD_TEMPLATES} = \@providers;
192 $config->{CLASS}->new($config) || do {
193 my $error = $config->{CLASS}->error();
194 $c->log->error($error);
204 my ( $self, $c ) = @_;
206 my $template = $c->stash->{template}
207 || $c->action . $self->config->{TEMPLATE_EXTENSION};
209 unless (defined $template) {
210 $c->log->debug('No template specified for rendering') if $c->debug;
215 my $output = eval { $self->render($c, $template) };
217 return $self->_rendering_error($c, $template . ': ' . $err);
219 if (blessed($output) && $output->isa('Template::Exception')) {
220 $self->_rendering_error($c, $output);
223 unless ( $c->response->content_type ) {
224 $c->response->content_type('text/html; charset=utf-8');
227 $c->response->body($output);
232 sub _rendering_error {
233 my ($self, $c, $err) = @_;
234 my $error = qq/Couldn't render template "$err"/;
235 $c->log->error($error);
241 my ($self, $c, $template, $args) = @_;
243 $c->log->debug(qq/Rendering template "$template"/) if $c && $c->debug;
247 (ref $args eq 'HASH' ? %$args : %{ $c->stash() }),
248 $self->template_vars($c)
251 local $self->{include_path} =
252 [ @{ $vars->{additional_template_paths} }, @{ $self->{include_path} } ]
253 if ref $vars->{additional_template_paths};
255 unless ( $self->template->process( $template, $vars, \$output ) ) {
256 if (exists $self->{render_die}) {
257 die $self->template->error if $self->{render_die};
258 return $self->template->error;
260 $c->log->debug('The Catalyst::View::TT render() method will start dying on error in a future release. Unless you are calling the render() method manually, you probably want the new behaviour, so set render_die => 1 in config for ' . blessed($self) . '. If you wish to continue to return the exception rather than throwing it, add render_die => 0 to your config.') if $c->debug;
261 return $self->template->error;
267 my ( $self, $c ) = @_;
270 my $cvar = $self->config->{CATALYST_VAR};
272 my %vars = defined $cvar
276 base => $c->req->base,
277 name => $c->config->{name}
280 if ($self->expose_methods) {
281 my $meta = $self->meta;
282 foreach my $method_name (@{$self->expose_methods}) {
283 my $method = $meta->find_method_by_name( $method_name );
285 Catalyst::Exception->throw( "$method_name not found in TT view" );
287 my $method_body = $method->body;
291 $self->$method_body($weak_ctx, @_);
293 $vars{$method_name} = $sub;
305 This is the Catalyst view class for the L<Template Toolkit|Template>.
306 Your application should defined a view class which is a subclass of
307 this module. Throughout this manual it will be assumed that your application
308 is named F<MyApp> and you are creating a TT view named F<Web>; these names
309 are placeholders and should always be replaced with whatever name you've
310 chosen for your application and your view. The easiest way to create a TT
311 view class is through the F<myapp_create.pl> script that is created along
312 with the application:
314 $ script/myapp_create.pl view Web TT
316 This creates a F<MyApp::View::Web.pm> module in the F<lib> directory (again,
317 replacing C<MyApp> with the name of your application) which looks
320 package FooBar::View::Web;
325 use base 'Catalyst::View::TT';
327 __PACKAGE__->config(DEBUG => 'all');
329 Now you can modify your action handlers in the main application and/or
330 controllers to forward to your view class. You might choose to do this
331 in the end() method, for example, to automatically forward all actions
332 to the TT view class.
334 # In MyApp or MyApp::Controller::SomeController
337 my( $self, $c ) = @_;
338 $c->forward( $c->view('Web') );
341 But if you are using the standard auto-generated end action, you don't even need
344 # in MyApp::Controller::Root
345 sub end : ActionClass('RenderView') {} # no need to change this line
350 default_view => 'Web',
353 This will Just Work. And it has the advantages that:
359 If you want to use a different view for a given request, just set
360 << $c->stash->{current_view} >>. (See L<Catalyst>'s C<< $c->view >> method
365 << $c->res->redirect >> is handled by default. If you just forward to
366 C<View::Web> in your C<end> routine, you could break this by sending additional
371 See L<Catalyst::Action::RenderView> for more details.
375 There are a three different ways to configure your view class. The
376 first way is to call the C<config()> method in the view subclass. This
377 happens when the module is first loaded.
379 package MyApp::View::Web;
381 extends 'Catalyst::View::TT';
383 __PACKAGE__->config({
384 PRE_PROCESS => 'config/main',
385 WRAPPER => 'site/wrapper',
388 You may also override the configuration provided in the view class by adding
389 a 'View::Web' section to your application config.
391 This should generally be used to inject the include paths into the view to
392 avoid the view trying to load the application to resolve paths.
394 .. inside MyApp.pm ..
398 __PACKAGE__->path_to( 'root', 'templates', 'lib' ),
399 __PACKAGE__->path_to( 'root', 'templates', 'src' ),
404 You can also configure your view from within your config file if you're
405 using L<Catalyst::Plugin::ConfigLoader>. This should be reserved for
406 deployment-specific concerns. For example:
408 # MyApp_local.conf (Config::General format)
411 WRAPPER "custom_wrapper"
412 INCLUDE_PATH __path_to('root/templates/custom_site')__
413 INCLUDE_PATH __path_to('root/templates')__
416 might be used as part of a simple way to deploy different instances of the
417 same application with different themes.
419 =head2 DYNAMIC INCLUDE_PATH
421 Sometimes it is desirable to modify INCLUDE_PATH for your templates at run time.
423 Additional paths can be added to the start of INCLUDE_PATH via the stash as
426 $c->stash->{additional_template_paths} =
427 [$c->config->{root} . '/test_include_path'];
429 If you need to add paths to the end of INCLUDE_PATH, there is also an
430 include_path() accessor available:
432 push( @{ $c->view('Web')->include_path }, qw/path/ );
434 Note that if you use include_path() to add extra paths to INCLUDE_PATH, you
435 MUST check for duplicate paths. Without such checking, the above code will add
436 "path" to INCLUDE_PATH at every request, causing a memory leak.
438 A safer approach is to use include_path() to overwrite the array of paths
439 rather than adding to it. This eliminates both the need to perform duplicate
440 checking and the chance of a memory leak:
442 @{ $c->view('Web')->include_path } = qw/path another_path/;
444 If you are calling C<render> directly then you can specify dynamic paths by
445 having a C<additional_template_paths> key with a value of additonal directories
446 to search. See L<CAPTURING TEMPLATE OUTPUT> for an example showing this.
448 =head2 RENDERING VIEWS
450 The view plugin renders the template specified in the C<template>
453 sub message : Global {
454 my ( $self, $c ) = @_;
455 $c->stash->{template} = 'message.tt2';
456 $c->forward( $c->view('Web') );
459 If a stash item isn't defined, then it instead uses the
460 stringification of the action dispatched to (as defined by $c->action)
461 in the above example, this would be C<message>, but because the default
462 is to append '.tt', it would load C<root/message.tt>.
464 The items defined in the stash are passed to the Template Toolkit for
465 use as template variables.
467 sub default : Private {
468 my ( $self, $c ) = @_;
469 $c->stash->{template} = 'message.tt2';
470 $c->stash->{message} = 'Hello World!';
471 $c->forward( $c->view('Web') );
474 A number of other template variables are also added:
476 c A reference to the context object, $c
477 base The URL base, from $c->req->base()
478 name The application name, from $c->config->{ name }
480 These can be accessed from the template in the usual way:
484 The message is: [% message %]
485 The base is [% base %]
486 The name is [% name %]
489 The output generated by the template is stored in C<< $c->response->body >>.
491 =head2 CAPTURING TEMPLATE OUTPUT
493 If you wish to use the output of a template for some other purpose than
494 displaying in the response, e.g. for sending an email, this is possible using
495 L<Catalyst::Plugin::Email> and the L<render> method:
497 sub send_email : Local {
502 To => 'me@localhost',
503 Subject => 'A TT Email',
505 body => $c->view('Web')->render($c, 'email.tt', {
506 additional_template_paths => [ $c->config->{root} . '/email_templates'],
507 email_tmpl_param1 => 'foo'
511 # Redirect or display a message
514 =head2 TEMPLATE PROFILING
516 See L<C<TIMER>> property of the L<config> method.
522 The constructor for the TT view. Sets up the template provider,
523 and reads the application config.
527 Renders the template specified in C<< $c->stash->{template} >> or
528 C<< $c->action >> (the private name of the matched action). Calls L<render> to
529 perform actual rendering. Output is stored in C<< $c->response->body >>.
531 It is possible to forward to the process method of a TT view from inside
534 $c->forward('View::Web');
536 N.B. This is usually done automatically by L<Catalyst::Action::RenderView>.
538 =head2 render($c, $template, \%args)
540 Renders the given template and returns output. Throws a L<Template::Exception>
543 The template variables are set to C<%$args> if C<$args> is a hashref, or
544 C<< $c->stash >> otherwise. In either case the variables are augmented with
545 C<base> set to C<< $c->req->base >>, C<c> to C<$c>, and C<name> to
546 C<< $c->config->{name} >>. Alternately, the C<CATALYST_VAR> configuration item
547 can be defined to specify the name of a template variable through which the
548 context reference (C<$c>) can be accessed. In this case, the C<c>, C<base>, and
549 C<name> variables are omitted.
551 C<$template> can be anything that Template::process understands how to
552 process, including the name of a template file or a reference to a test string.
553 See L<Template::process|Template/process> for a full list of supported formats.
555 To use the render method outside of your Catalyst app, just pass a undef context.
556 This can be useful for tests, for instance.
558 It is possible to forward to the render method of a TT view from inside Catalyst
559 to render page fragments like this:
561 my $fragment = $c->forward("View::Web", "render", $template_name, $c->stash->{fragment_data});
563 =head3 Backwards compatibility note
565 The render method used to just return the Template::Exception object, rather
566 than just throwing it. This is now deprecated and instead the render method
567 will throw an exception for new applications.
569 This behaviour can be activated (and is activated in the default skeleton
570 configuration) by using C<< render_die => 1 >>. If you rely on the legacy
571 behaviour then a warning will be issued.
573 To silence this warning, set C<< render_die => 0 >>, but it is recommended
574 you adjust your code so that it works with C<< render_die => 1 >>.
576 In a future release, C<< render_die => 1 >> will become the default if
581 Returns a list of keys/values to be used as the catalyst variables in the
586 This method allows your view subclass to pass additional settings to
587 the TT configuration hash, or to set the options as below:
591 The list of paths TT will look for templates in.
593 =head2 expose_methods
595 The list of methods in your View class which should be made available to the templates.
599 expose_methods => [qw/uri_for_css/],
604 my ($self, $c, $filename) = @_;
606 # additional complexity like checking file exists here
608 return $c->uri_for('/static/css/' . $filename);
611 Then in the template:
613 [% uri_for_css('home.css') %]
615 =head2 C<CATALYST_VAR>
617 Allows you to change the name of the Catalyst context object. If set, it will also
618 remove the base and name aliases, so you will have access them through <context>.
620 For example, if CATALYST_VAR has been set to "Catalyst", a template might
623 The base is [% Catalyst.req.base %]
624 The name is [% Catalyst.config.name %]
628 If you have configured Catalyst for debug output, and turned on the TIMER setting,
629 C<Catalyst::View::TT> will enable profiling of template processing
630 (using L<Template::Timer>). This will embed HTML comments in the
631 output from your templates, such as:
633 <!-- TIMER START: process mainmenu/mainmenu.ttml -->
634 <!-- TIMER START: include mainmenu/cssindex.tt -->
635 <!-- TIMER START: process mainmenu/cssindex.tt -->
636 <!-- TIMER END: process mainmenu/cssindex.tt (0.017279 seconds) -->
637 <!-- TIMER END: include mainmenu/cssindex.tt (0.017401 seconds) -->
641 <!-- TIMER END: process mainmenu/footer.tt (0.003016 seconds) -->
644 =head2 C<TEMPLATE_EXTENSION>
646 a sufix to add when looking for templates bases on the C<match> method in L<Catalyst::Request>.
650 package MyApp::Controller::Test;
651 sub test : Local { .. }
653 Would by default look for a template in <root>/test/test. If you set TEMPLATE_EXTENSION to '.tt', it will look for
658 Allows you to specify the template providers that TT will use.
662 root => MyApp->path_to('root'),
668 DBI_DSN => 'dbi:DB2:books',
679 The 'name' key should correspond to the class name of the provider you
680 want to use. The _file_ name is a special case that represents the default
681 TT file-based provider. By default the name is will be prefixed with
682 'Template::Provider::'. You can fully qualify the name by using a unary
685 name => '+MyApp::Provider::Foo'
687 You can also specify the 'copy_config' key as an arrayref, to copy those keys
688 from the general config, into the config for the provider:
690 DEFAULT_ENCODING => 'utf-8',
694 copy_config => [qw(DEFAULT_ENCODING INCLUDE_PATH)]
698 This can prove useful when you want to use the additional_template_paths hack
699 in your own provider, or if you need to use Template::Provider::Encoding
703 Allows you to specify a custom class to use as the template class instead of
706 package MyApp::View::Web;
709 use base 'Catalyst::View::TT';
711 use Template::AutoFilter;
713 __PACKAGE__->config({
714 CLASS => 'Template::AutoFilter',
717 This is useful if you want to use your own subclasses of L<Template>, so you
718 can, for example, prevent XSS by automatically filtering all output through
723 The L<Catalyst::Helper::View::TT> and
724 L<Catalyst::Helper::View::TTSite> helper modules are provided to create
725 your view module. There are invoked by the F<myapp_create.pl> script:
727 $ script/myapp_create.pl view Web TT
729 $ script/myapp_create.pl view Web TTSite
731 The L<Catalyst::Helper::View::TT> module creates a basic TT view
732 module. The L<Catalyst::Helper::View::TTSite> module goes a little
733 further. It also creates a default set of templates to get you
734 started. It also configures the view module to locate the templates
739 If you are using the L<CGI> module inside your templates, you will
740 experience that the Catalyst server appears to hang while rendering
741 the web page. This is due to the debug mode of L<CGI> (which is
742 waiting for input in the terminal window). Turning off the
743 debug mode using the "-no_debug" option solves the
746 [% USE CGI('-no_debug') %]
750 L<Catalyst>, L<Catalyst::Helper::View::TT>,
751 L<Catalyst::Helper::View::TTSite>, L<Template::Manual>
755 Sebastian Riedel, C<sri@cpan.org>
757 Marcus Ramberg, C<mramberg@cpan.org>
759 Jesse Sheidlower, C<jester@panix.com>
761 Andy Wardley, C<abw@cpan.org>
763 Luke Saunders, C<luke.saunders@gmail.com>
767 This program is free software. You can redistribute it and/or modify it
768 under the same terms as Perl itself.