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
36 TEMPLATE_EXTENSION => '.tt',
41 PRE_PROCESS => 'config/main',
42 WRAPPER => 'site/wrapper',
43 render_die => 1, # Default for new apps, see render method docs
44 expose_methods => [qw/method_in_view_class/],
47 # add include path configuration in MyApp.pm
52 __PACKAGE__->path_to( 'root', 'src' ),
53 __PACKAGE__->path_to( 'root', 'lib' ),
58 # render view from lib/MyApp.pm or lib/MyApp::Controller::SomeController.pm
60 sub message : Global {
61 my ( $self, $c ) = @_;
62 $c->stash->{template} = 'message.tt2';
63 $c->stash->{message} = 'Hello World!';
64 $c->forward( $c->view('Web') );
67 # access variables from template
69 The message is: [% message %].
71 # example when CATALYST_VAR is set to 'Catalyst'
72 Context is [% Catalyst %]
73 The base is [% Catalyst.req.base %]
74 The name is [% Catalyst.config.name %]
76 # example when CATALYST_VAR isn't set
78 The base is [% base %]
79 The name is [% name %]
84 my ( $paths, $dlim ) = shift;
85 return () if ( !$paths );
86 return @{$paths} if ( ref $paths eq 'ARRAY' );
88 # tweak delim to ignore C:/
89 unless ( defined $dlim ) {
90 $dlim = ( $^O eq 'MSWin32' ) ? ':(?!\\/)' : ':';
92 return split( /$dlim/, $paths );
96 my ( $class, $c, $arguments ) = @_;
99 TEMPLATE_EXTENSION => '',
104 if ( ! (ref $config->{INCLUDE_PATH} eq 'ARRAY') ) {
105 my $delim = $config->{DELIMITER};
107 = _coerce_paths( $config->{INCLUDE_PATH}, $delim );
108 if ( !@include_path ) {
109 my $root = $c->config->{root};
110 my $base = Path::Class::dir( $root, 'base' );
111 @include_path = ( "$root", "$base" );
113 $config->{INCLUDE_PATH} = \@include_path;
116 # if we're debugging and/or the TIMER option is set, then we install
117 # Template::Timer as a custom CONTEXT object, but only if we haven't
118 # already got a custom CONTEXT defined
120 if ( $config->{TIMER} ) {
121 if ( $config->{CONTEXT} ) {
123 'Cannot use Template::Timer - a TT CONTEXT is already defined'
127 $config->{CONTEXT} = Template::Timer->new(%$config);
131 if ( $c->debug && $config->{DUMP_CONFIG} ) {
132 $c->log->debug( "TT Config: ", dump($config) );
135 my $self = $class->next::method(
139 # Set base include paths. Local'd in render if needed
140 $self->include_path($config->{INCLUDE_PATH});
142 $self->expose_methods($config->{expose_methods});
143 $self->config($config);
145 # Creation of template outside of call to new so that we can pass [ $self ]
146 # as INCLUDE_PATH config item, which then gets ->paths() called to get list
147 # of include paths to search for templates.
149 # Use a weakend copy of self so we dont have loops preventing GC from working
151 Scalar::Util::weaken($copy);
152 $config->{INCLUDE_PATH} = [ sub { $copy->paths } ];
154 if ( $config->{PROVIDERS} ) {
156 if ( ref($config->{PROVIDERS}) eq 'ARRAY') {
157 foreach my $p (@{$config->{PROVIDERS}}) {
158 my $pname = $p->{name};
159 my $prov = 'Template::Provider';
160 if($pname eq '_file_')
162 $p->{args} = { %$config };
166 if($pname =~ s/^\+//) {
173 # We copy the args people want from the config
176 if ($p->{copy_config}) {
177 map { $p->{args}->{$_} = $config->{$_} }
178 grep { exists $config->{$_} }
179 @{ $p->{copy_config} };
183 eval "require $prov";
185 push @providers, "$prov"->new($p->{args});
189 $c->log->warn("Can't load $prov, ($@)");
193 delete $config->{PROVIDERS};
195 $config->{LOAD_TEMPLATES} = \@providers;
200 $config->{CLASS}->new($config) || do {
201 my $error = $config->{CLASS}->error();
202 $c->log->error($error);
212 my ( $self, $c ) = @_;
214 my $template = $c->stash->{template}
215 || $c->action . $self->config->{TEMPLATE_EXTENSION};
217 unless (defined $template) {
218 $c->log->debug('No template specified for rendering') if $c->debug;
223 my $output = eval { $self->render($c, $template) };
225 return $self->_rendering_error($c, $template . ': ' . $err);
227 if (blessed($output) && $output->isa('Template::Exception')) {
228 $self->_rendering_error($c, $output);
231 unless ( $c->response->content_type ) {
232 $c->response->content_type('text/html; charset=utf-8');
235 $c->response->body($output);
240 sub _rendering_error {
241 my ($self, $c, $err) = @_;
242 my $error = qq/Couldn't render template "$err"/;
243 $c->log->error($error);
249 my ($self, $c, $template, $args) = @_;
251 $c->log->debug(qq/Rendering template "$template"/) if $c && $c->debug;
255 (ref $args eq 'HASH' ? %$args : %{ $c->stash() }),
256 $self->template_vars($c)
259 local $self->{include_path} =
260 [ @{ $vars->{additional_template_paths} }, @{ $self->{include_path} } ]
261 if ref $vars->{additional_template_paths};
263 unless ( $self->template->process( $template, $vars, \$output ) ) {
264 if (exists $self->{render_die}) {
265 die $self->template->error if $self->{render_die};
266 return $self->template->error;
268 $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;
269 return $self->template->error;
275 my ( $self, $c ) = @_;
278 my $cvar = $self->config->{CATALYST_VAR};
280 my %vars = defined $cvar
284 base => $c->req->base,
285 name => $c->config->{name}
288 if ($self->expose_methods) {
289 my $meta = $self->meta;
290 foreach my $method_name (@{$self->expose_methods}) {
291 my $method = $meta->find_method_by_name( $method_name );
293 Catalyst::Exception->throw( "$method_name not found in TT view" );
295 my $method_body = $method->body;
299 $self->$method_body($weak_ctx, @_);
301 $vars{$method_name} = $sub;
313 This is the Catalyst view class for the L<Template Toolkit|Template>.
314 Your application should defined a view class which is a subclass of
315 this module. Throughout this manual it will be assumed that your application
316 is named F<MyApp> and you are creating a TT view named F<Web>; these names
317 are placeholders and should always be replaced with whatever name you've
318 chosen for your application and your view. The easiest way to create a TT
319 view class is through the F<myapp_create.pl> script that is created along
320 with the application:
322 $ script/myapp_create.pl view Web TT
324 This creates a F<MyApp::View::Web.pm> module in the F<lib> directory (again,
325 replacing C<MyApp> with the name of your application) which looks
328 package FooBar::View::Web;
333 use base 'Catalyst::View::TT';
335 __PACKAGE__->config(DEBUG => 'all');
337 Now you can modify your action handlers in the main application and/or
338 controllers to forward to your view class. You might choose to do this
339 in the end() method, for example, to automatically forward all actions
340 to the TT view class.
342 # In MyApp or MyApp::Controller::SomeController
345 my( $self, $c ) = @_;
346 $c->forward( $c->view('Web') );
349 But if you are using the standard auto-generated end action, you don't even need
352 # in MyApp::Controller::Root
353 sub end : ActionClass('RenderView') {} # no need to change this line
358 default_view => 'Web',
361 This will Just Work. And it has the advantages that:
367 If you want to use a different view for a given request, just set
368 << $c->stash->{current_view} >>. (See L<Catalyst>'s C<< $c->view >> method
373 << $c->res->redirect >> is handled by default. If you just forward to
374 C<View::Web> in your C<end> routine, you could break this by sending additional
379 See L<Catalyst::Action::RenderView> for more details.
383 There are a three different ways to configure your view class. The
384 first way is to call the C<config()> method in the view subclass. This
385 happens when the module is first loaded.
387 package MyApp::View::Web;
389 extends 'Catalyst::View::TT';
391 __PACKAGE__->config({
392 PRE_PROCESS => 'config/main',
393 WRAPPER => 'site/wrapper',
396 You may also override the configuration provided in the view class by adding
397 a 'View::Web' section to your application config.
399 This should generally be used to inject the include paths into the view to
400 avoid the view trying to load the application to resolve paths.
402 .. inside MyApp.pm ..
406 __PACKAGE__->path_to( 'root', 'templates', 'lib' ),
407 __PACKAGE__->path_to( 'root', 'templates', 'src' ),
412 You can also configure your view from within your config file if you're
413 using L<Catalyst::Plugin::ConfigLoader>. This should be reserved for
414 deployment-specific concerns. For example:
416 # MyApp_local.conf (Config::General format)
419 WRAPPER "custom_wrapper"
420 INCLUDE_PATH __path_to('root/templates/custom_site')__
421 INCLUDE_PATH __path_to('root/templates')__
424 might be used as part of a simple way to deploy different instances of the
425 same application with different themes.
427 =head2 DYNAMIC INCLUDE_PATH
429 Sometimes it is desirable to modify INCLUDE_PATH for your templates at run time.
431 Additional paths can be added to the start of INCLUDE_PATH via the stash as
434 $c->stash->{additional_template_paths} =
435 [$c->config->{root} . '/test_include_path'];
437 If you need to add paths to the end of INCLUDE_PATH, there is also an
438 include_path() accessor available:
440 push( @{ $c->view('Web')->include_path }, qw/path/ );
442 Note that if you use include_path() to add extra paths to INCLUDE_PATH, you
443 MUST check for duplicate paths. Without such checking, the above code will add
444 "path" to INCLUDE_PATH at every request, causing a memory leak.
446 A safer approach is to use include_path() to overwrite the array of paths
447 rather than adding to it. This eliminates both the need to perform duplicate
448 checking and the chance of a memory leak:
450 @{ $c->view('Web')->include_path } = qw/path another_path/;
452 If you are calling C<render> directly then you can specify dynamic paths by
453 having a C<additional_template_paths> key with a value of additonal directories
454 to search. See L<CAPTURING TEMPLATE OUTPUT> for an example showing this.
458 Be sure to set C<< ENCODING => 'utf-8' >> and use
459 L<Catalyst::Plugin::Unicode::Encoding> if you want to use non-ascii
460 characters (encoded as utf-8) in your templates.
462 =head2 RENDERING VIEWS
464 The view plugin renders the template specified in the C<template>
467 sub message : Global {
468 my ( $self, $c ) = @_;
469 $c->stash->{template} = 'message.tt2';
470 $c->forward( $c->view('Web') );
473 If a stash item isn't defined, then it instead uses the
474 stringification of the action dispatched to (as defined by $c->action)
475 in the above example, this would be C<message>, but because the default
476 is to append '.tt', it would load C<root/message.tt>.
478 The items defined in the stash are passed to the Template Toolkit for
479 use as template variables.
481 sub default : Private {
482 my ( $self, $c ) = @_;
483 $c->stash->{template} = 'message.tt2';
484 $c->stash->{message} = 'Hello World!';
485 $c->forward( $c->view('Web') );
488 A number of other template variables are also added:
490 c A reference to the context object, $c
491 base The URL base, from $c->req->base()
492 name The application name, from $c->config->{ name }
494 These can be accessed from the template in the usual way:
498 The message is: [% message %]
499 The base is [% base %]
500 The name is [% name %]
503 The output generated by the template is stored in C<< $c->response->body >>.
505 =head2 CAPTURING TEMPLATE OUTPUT
507 If you wish to use the output of a template for some other purpose than
508 displaying in the response, e.g. for sending an email, this is possible using
509 L<Catalyst::Plugin::Email> and the L<render> method:
511 sub send_email : Local {
516 To => 'me@localhost',
517 Subject => 'A TT Email',
519 body => $c->view('Web')->render($c, 'email.tt', {
520 additional_template_paths => [ $c->config->{root} . '/email_templates'],
521 email_tmpl_param1 => 'foo'
525 # Redirect or display a message
528 =head2 TEMPLATE PROFILING
530 See L<C<TIMER>> property of the L<config> method.
536 The constructor for the TT view. Sets up the template provider,
537 and reads the application config.
541 Renders the template specified in C<< $c->stash->{template} >> or
542 C<< $c->action >> (the private name of the matched action). Calls L<render> to
543 perform actual rendering. Output is stored in C<< $c->response->body >>.
545 It is possible to forward to the process method of a TT view from inside
548 $c->forward('View::Web');
550 N.B. This is usually done automatically by L<Catalyst::Action::RenderView>.
552 =head2 render($c, $template, \%args)
554 Renders the given template and returns output. Throws a L<Template::Exception>
557 The template variables are set to C<%$args> if C<$args> is a hashref, or
558 C<< $c->stash >> otherwise. In either case the variables are augmented with
559 C<base> set to C<< $c->req->base >>, C<c> to C<$c>, and C<name> to
560 C<< $c->config->{name} >>. Alternately, the C<CATALYST_VAR> configuration item
561 can be defined to specify the name of a template variable through which the
562 context reference (C<$c>) can be accessed. In this case, the C<c>, C<base>, and
563 C<name> variables are omitted.
565 C<$template> can be anything that Template::process understands how to
566 process, including the name of a template file or a reference to a test string.
567 See L<Template::process|Template/process> for a full list of supported formats.
569 To use the render method outside of your Catalyst app, just pass a undef context.
570 This can be useful for tests, for instance.
572 It is possible to forward to the render method of a TT view from inside Catalyst
573 to render page fragments like this:
575 my $fragment = $c->forward("View::Web", "render", $template_name, $c->stash->{fragment_data});
577 =head3 Backwards compatibility note
579 The render method used to just return the Template::Exception object, rather
580 than just throwing it. This is now deprecated and instead the render method
581 will throw an exception for new applications.
583 This behaviour can be activated (and is activated in the default skeleton
584 configuration) by using C<< render_die => 1 >>. If you rely on the legacy
585 behaviour then a warning will be issued.
587 To silence this warning, set C<< render_die => 0 >>, but it is recommended
588 you adjust your code so that it works with C<< render_die => 1 >>.
590 In a future release, C<< render_die => 1 >> will become the default if
595 Returns a list of keys/values to be used as the catalyst variables in the
600 This method allows your view subclass to pass additional settings to
601 the TT configuration hash, or to set the options as below:
605 The list of paths TT will look for templates in.
607 =head2 expose_methods
609 The list of methods in your View class which should be made available to the templates.
613 expose_methods => [qw/uri_for_css/],
618 my ($self, $c, $filename) = @_;
620 # additional complexity like checking file exists here
622 return $c->uri_for('/static/css/' . $filename);
625 Then in the template:
627 [% uri_for_css('home.css') %]
629 =head2 C<CATALYST_VAR>
631 Allows you to change the name of the Catalyst context object. If set, it will also
632 remove the base and name aliases, so you will have access them through <context>.
634 For example, if CATALYST_VAR has been set to "Catalyst", a template might
637 The base is [% Catalyst.req.base %]
638 The name is [% Catalyst.config.name %]
642 If you have configured Catalyst for debug output, and turned on the TIMER setting,
643 C<Catalyst::View::TT> will enable profiling of template processing
644 (using L<Template::Timer>). This will embed HTML comments in the
645 output from your templates, such as:
647 <!-- TIMER START: process mainmenu/mainmenu.ttml -->
648 <!-- TIMER START: include mainmenu/cssindex.tt -->
649 <!-- TIMER START: process mainmenu/cssindex.tt -->
650 <!-- TIMER END: process mainmenu/cssindex.tt (0.017279 seconds) -->
651 <!-- TIMER END: include mainmenu/cssindex.tt (0.017401 seconds) -->
655 <!-- TIMER END: process mainmenu/footer.tt (0.003016 seconds) -->
658 =head2 C<TEMPLATE_EXTENSION>
660 a sufix to add when looking for templates bases on the C<match> method in L<Catalyst::Request>.
664 package MyApp::Controller::Test;
665 sub test : Local { .. }
667 Would by default look for a template in <root>/test/test. If you set TEMPLATE_EXTENSION to '.tt', it will look for
672 Allows you to specify the template providers that TT will use.
676 root => MyApp->path_to('root'),
682 DBI_DSN => 'dbi:DB2:books',
693 The 'name' key should correspond to the class name of the provider you
694 want to use. The _file_ name is a special case that represents the default
695 TT file-based provider. By default the name is will be prefixed with
696 'Template::Provider::'. You can fully qualify the name by using a unary
699 name => '+MyApp::Provider::Foo'
701 You can also specify the 'copy_config' key as an arrayref, to copy those keys
702 from the general config, into the config for the provider:
704 DEFAULT_ENCODING => 'utf-8',
708 copy_config => [qw(DEFAULT_ENCODING INCLUDE_PATH)]
712 This can prove useful when you want to use the additional_template_paths hack
713 in your own provider, or if you need to use Template::Provider::Encoding
717 Allows you to specify a custom class to use as the template class instead of
720 package MyApp::View::Web;
723 use base 'Catalyst::View::TT';
725 use Template::AutoFilter;
727 __PACKAGE__->config({
728 CLASS => 'Template::AutoFilter',
731 This is useful if you want to use your own subclasses of L<Template>, so you
732 can, for example, prevent XSS by automatically filtering all output through
737 The L<Catalyst::Helper::View::TT> and
738 L<Catalyst::Helper::View::TTSite> helper modules are provided to create
739 your view module. There are invoked by the F<myapp_create.pl> script:
741 $ script/myapp_create.pl view Web TT
743 $ script/myapp_create.pl view Web TTSite
745 The L<Catalyst::Helper::View::TT> module creates a basic TT view
746 module. The L<Catalyst::Helper::View::TTSite> module goes a little
747 further. It also creates a default set of templates to get you
748 started. It also configures the view module to locate the templates
753 If you are using the L<CGI> module inside your templates, you will
754 experience that the Catalyst server appears to hang while rendering
755 the web page. This is due to the debug mode of L<CGI> (which is
756 waiting for input in the terminal window). Turning off the
757 debug mode using the "-no_debug" option solves the
760 [% USE CGI('-no_debug') %]
764 L<Catalyst>, L<Catalyst::Helper::View::TT>,
765 L<Catalyst::Helper::View::TTSite>, L<Template::Manual>
769 Sebastian Riedel, C<sri@cpan.org>
771 Marcus Ramberg, C<mramberg@cpan.org>
773 Jesse Sheidlower, C<jester@panix.com>
775 Andy Wardley, C<abw@cpan.org>
777 Luke Saunders, C<luke.saunders@gmail.com>
781 This program is free software. You can redistribute it and/or modify it
782 under the same terms as Perl itself.