1 package Catalyst::View::TT;
6 use base qw/Catalyst::View/;
11 use Scalar::Util qw/blessed weaken/;
13 our $VERSION = '0.35';
15 __PACKAGE__->mk_accessors('template');
16 __PACKAGE__->mk_accessors('expose_methods');
17 __PACKAGE__->mk_accessors('include_path');
19 *paths = \&include_path;
23 Catalyst::View::TT - Template View Class
27 # use the helper to create your View
29 myapp_create.pl view Web TT
31 # add custom configration in View/Web.pm
34 # any TT configuration items go here
36 MyApp->path_to( 'root', 'src' ),
37 MyApp->path_to( 'root', 'lib' ),
39 TEMPLATE_EXTENSION => '.tt',
43 PRE_PROCESS => 'config/main',
44 WRAPPER => 'site/wrapper',
45 render_die => 1, # Default for new apps, see render method docs
46 expose_methods => [qw/method_in_view_class/],
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('Web') );
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->expose_methods($config->{expose_methods});
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 return $self->_rendering_error($c, $template . ': ' . $err);
217 if (blessed($output) && $output->isa('Template::Exception')) {
218 $self->_rendering_error($c, $output);
221 unless ( $c->response->content_type ) {
222 $c->response->content_type('text/html; charset=utf-8');
225 $c->response->body($output);
230 sub _rendering_error {
231 my ($self, $c, $err) = @_;
232 my $error = qq/Couldn't render template "$err"/;
233 $c->log->error($error);
239 my ($self, $c, $template, $args) = @_;
241 $c->log->debug(qq/Rendering template "$template"/) if $c && $c->debug;
245 (ref $args eq 'HASH' ? %$args : %{ $c->stash() }),
246 $self->template_vars($c)
249 local $self->{include_path} =
250 [ @{ $vars->{additional_template_paths} }, @{ $self->{include_path} } ]
251 if ref $vars->{additional_template_paths};
253 unless ( $self->template->process( $template, $vars, \$output ) ) {
254 if (exists $self->{render_die}) {
255 die $self->template->error if $self->{render_die};
256 return $self->template->error;
258 $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;
259 return $self->template->error;
265 my ( $self, $c ) = @_;
268 my $cvar = $self->config->{CATALYST_VAR};
270 my %vars = defined $cvar
274 base => $c->req->base,
275 name => $c->config->{name}
278 if ($self->expose_methods) {
279 my $meta = $self->meta;
280 foreach my $method_name (@{$self->expose_methods}) {
281 my $method = $meta->get_method( $method_name );
283 Catalyst::Exception->throw( "$method_name not found in TT view" );
285 my $method_body = $method->body;
289 $self->$method_body($weak_ctx, @_);
291 $vars{$method_name} = $sub;
303 This is the Catalyst view class for the L<Template Toolkit|Template>.
304 Your application should defined a view class which is a subclass of
305 this module. Throughout this manual it will be assumed that your application
306 is named F<MyApp> and you are creating a TT view named F<Web>; these names
307 are placeholders and should always be replaced with whatever name you've
308 chosen for your application and your view. The easiest way to create a TT
309 view class is through the F<myapp_create.pl> script that is created along
310 with the application:
312 $ script/myapp_create.pl view Web TT
314 This creates a F<MyApp::View::Web.pm> module in the F<lib> directory (again,
315 replacing C<MyApp> with the name of your application) which looks
318 package FooBar::View::Web;
323 use base 'Catalyst::View::TT';
325 __PACKAGE__->config(DEBUG => 'all');
327 Now you can modify your action handlers in the main application and/or
328 controllers to forward to your view class. You might choose to do this
329 in the end() method, for example, to automatically forward all actions
330 to the TT view class.
332 # In MyApp or MyApp::Controller::SomeController
335 my( $self, $c ) = @_;
336 $c->forward( $c->view('Web') );
339 But if you are using the standard auto-generated end action, you don't even need
342 # in MyApp::Controller::Root
343 sub end : ActionClass('RenderView') {} # no need to change this line
348 default_view => 'Web',
351 This will Just Work. And it has the advantages that:
357 If you want to use a different view for a given request, just set
358 << $c->stash->{current_view} >>. (See L<Catalyst>'s C<< $c->view >> method
363 << $c->res->redirect >> is handled by default. If you just forward to
364 C<View::Web> in your C<end> routine, you could break this by sending additional
369 See L<Catalyst::Action::RenderView> for more details.
373 There are a three different ways to configure your view class. The
374 first way is to call the C<config()> method in the view subclass. This
375 happens when the module is first loaded.
377 package MyApp::View::Web;
380 use base 'Catalyst::View::TT';
382 __PACKAGE__->config({
384 MyApp->path_to( 'root', 'templates', 'lib' ),
385 MyApp->path_to( 'root', 'templates', 'src' ),
387 PRE_PROCESS => 'config/main',
388 WRAPPER => 'site/wrapper',
391 You may also override the configuration provided in the view class by adding
392 a 'View::Web' section to your application config (either in the application
393 main class, or in your configuration file). This should be reserved for
394 deployment-specific concerns. For example:
396 # MyApp_local.conf (Config::General format)
399 WRAPPER "custom_wrapper"
400 INCLUDE_PATH __path_to('root/templates/custom_site')__
401 INCLUDE_PATH __path_to('root/templates')__
404 might be used as part of a simple way to deploy different instances of the
405 same application with different themes.
407 =head2 DYNAMIC INCLUDE_PATH
409 Sometimes it is desirable to modify INCLUDE_PATH for your templates at run time.
411 Additional paths can be added to the start of INCLUDE_PATH via the stash as
414 $c->stash->{additional_template_paths} =
415 [$c->config->{root} . '/test_include_path'];
417 If you need to add paths to the end of INCLUDE_PATH, there is also an
418 include_path() accessor available:
420 push( @{ $c->view('Web')->include_path }, qw/path/ );
422 Note that if you use include_path() to add extra paths to INCLUDE_PATH, you
423 MUST check for duplicate paths. Without such checking, the above code will add
424 "path" to INCLUDE_PATH at every request, causing a memory leak.
426 A safer approach is to use include_path() to overwrite the array of paths
427 rather than adding to it. This eliminates both the need to perform duplicate
428 checking and the chance of a memory leak:
430 @{ $c->view('Web')->include_path } = qw/path another_path/;
432 If you are calling C<render> directly then you can specify dynamic paths by
433 having a C<additional_template_paths> key with a value of additonal directories
434 to search. See L<CAPTURING TEMPLATE OUTPUT> for an example showing this.
436 =head2 RENDERING VIEWS
438 The view plugin renders the template specified in the C<template>
441 sub message : Global {
442 my ( $self, $c ) = @_;
443 $c->stash->{template} = 'message.tt2';
444 $c->forward( $c->view('Web') );
447 If a stash item isn't defined, then it instead uses the
448 stringification of the action dispatched to (as defined by $c->action)
449 in the above example, this would be C<message>, but because the default
450 is to append '.tt', it would load C<root/message.tt>.
452 The items defined in the stash are passed to the Template Toolkit for
453 use as template variables.
455 sub default : Private {
456 my ( $self, $c ) = @_;
457 $c->stash->{template} = 'message.tt2';
458 $c->stash->{message} = 'Hello World!';
459 $c->forward( $c->view('Web') );
462 A number of other template variables are also added:
464 c A reference to the context object, $c
465 base The URL base, from $c->req->base()
466 name The application name, from $c->config->{ name }
468 These can be accessed from the template in the usual way:
472 The message is: [% message %]
473 The base is [% base %]
474 The name is [% name %]
477 The output generated by the template is stored in C<< $c->response->body >>.
479 =head2 CAPTURING TEMPLATE OUTPUT
481 If you wish to use the output of a template for some other purpose than
482 displaying in the response, e.g. for sending an email, this is possible using
483 L<Catalyst::Plugin::Email> and the L<render> method:
485 sub send_email : Local {
490 To => 'me@localhost',
491 Subject => 'A TT Email',
493 body => $c->view('Web')->render($c, 'email.tt', {
494 additional_template_paths => [ $c->config->{root} . '/email_templates'],
495 email_tmpl_param1 => 'foo'
499 # Redirect or display a message
502 =head2 TEMPLATE PROFILING
504 See L<C<TIMER>> property of the L<config> method.
510 The constructor for the TT view. Sets up the template provider,
511 and reads the application config.
515 Renders the template specified in C<< $c->stash->{template} >> or
516 C<< $c->action >> (the private name of the matched action). Calls L<render> to
517 perform actual rendering. Output is stored in C<< $c->response->body >>.
519 It is possible to forward to the process method of a TT view from inside
522 $c->forward('View::Web');
524 N.B. This is usually done automatically by L<Catalyst::Action::RenderView>.
526 =head2 render($c, $template, \%args)
528 Renders the given template and returns output. Throws a L<Template::Exception>
531 The template variables are set to C<%$args> if C<$args> is a hashref, or
532 C<< $c->stash >> otherwise. In either case the variables are augmented with
533 C<base> set to C<< $c->req->base >>, C<c> to C<$c>, and C<name> to
534 C<< $c->config->{name} >>. Alternately, the C<CATALYST_VAR> configuration item
535 can be defined to specify the name of a template variable through which the
536 context reference (C<$c>) can be accessed. In this case, the C<c>, C<base>, and
537 C<name> variables are omitted.
539 C<$template> can be anything that Template::process understands how to
540 process, including the name of a template file or a reference to a test string.
541 See L<Template::process|Template/process> for a full list of supported formats.
543 To use the render method outside of your Catalyst app, just pass a undef context.
544 This can be useful for tests, for instance.
546 It is possible to forward to the render method of a TT view from inside Catalyst
547 to render page fragments like this:
549 my $fragment = $c->forward("View::Web", "render", $template_name, $c->stash->{fragment_data});
551 =head3 Backwards compatibility note
553 The render method used to just return the Template::Exception object, rather
554 than just throwing it. This is now deprecated and instead the render method
555 will throw an exception for new applications.
557 This behaviour can be activated (and is activated in the default skeleton
558 configuration) by using C<< render_die => 1 >>. If you rely on the legacy
559 behaviour then a warning will be issued.
561 To silence this warning, set C<< render_die => 0 >>, but it is recommended
562 you adjust your code so that it works with C<< render_die => 1 >>.
564 In a future release, C<< render_die => 1 >> will become the default if
569 Returns a list of keys/values to be used as the catalyst variables in the
574 This method allows your view subclass to pass additional settings to
575 the TT configuration hash, or to set the options as below:
579 The list of paths TT will look for templates in.
581 =head2 expose_methods
583 The list of methods in your View class which should be made available to the templates.
587 expose_methods => [qw/uri_for_static/],
592 my ($self, $c, $filename) = @_;
594 # additional complexity like checking file exists here
596 return $c->uri_for('/static/css/' . $filename);
599 Then in the template:
601 [% uri_for_css('home.css') %]
603 =head2 C<CATALYST_VAR>
605 Allows you to change the name of the Catalyst context object. If set, it will also
606 remove the base and name aliases, so you will have access them through <context>.
608 For example, if CATALYST_VAR has been set to "Catalyst", a template might
611 The base is [% Catalyst.req.base %]
612 The name is [% Catalyst.config.name %]
616 If you have configured Catalyst for debug output, and turned on the TIMER setting,
617 C<Catalyst::View::TT> will enable profiling of template processing
618 (using L<Template::Timer>). This will embed HTML comments in the
619 output from your templates, such as:
621 <!-- TIMER START: process mainmenu/mainmenu.ttml -->
622 <!-- TIMER START: include mainmenu/cssindex.tt -->
623 <!-- TIMER START: process mainmenu/cssindex.tt -->
624 <!-- TIMER END: process mainmenu/cssindex.tt (0.017279 seconds) -->
625 <!-- TIMER END: include mainmenu/cssindex.tt (0.017401 seconds) -->
629 <!-- TIMER END: process mainmenu/footer.tt (0.003016 seconds) -->
632 =head2 C<TEMPLATE_EXTENSION>
634 a sufix to add when looking for templates bases on the C<match> method in L<Catalyst::Request>.
638 package MyApp::Controller::Test;
639 sub test : Local { .. }
641 Would by default look for a template in <root>/test/test. If you set TEMPLATE_EXTENSION to '.tt', it will look for
646 Allows you to specify the template providers that TT will use.
650 root => MyApp->path_to('root'),
656 DBI_DSN => 'dbi:DB2:books',
667 The 'name' key should correspond to the class name of the provider you
668 want to use. The _file_ name is a special case that represents the default
669 TT file-based provider. By default the name is will be prefixed with
670 'Template::Provider::'. You can fully qualify the name by using a unary
673 name => '+MyApp::Provider::Foo'
675 You can also specify the 'copy_config' key as an arrayref, to copy those keys
676 from the general config, into the config for the provider:
678 DEFAULT_ENCODING => 'utf-8',
682 copy_config => [qw(DEFAULT_ENCODING INCLUDE_PATH)]
686 This can prove useful when you want to use the additional_template_paths hack
687 in your own provider, or if you need to use Template::Provider::Encoding
691 The L<Catalyst::Helper::View::TT> and
692 L<Catalyst::Helper::View::TTSite> helper modules are provided to create
693 your view module. There are invoked by the F<myapp_create.pl> script:
695 $ script/myapp_create.pl view Web TT
697 $ script/myapp_create.pl view Web TTSite
699 The L<Catalyst::Helper::View::TT> module creates a basic TT view
700 module. The L<Catalyst::Helper::View::TTSite> module goes a little
701 further. It also creates a default set of templates to get you
702 started. It also configures the view module to locate the templates
707 If you are using the L<CGI> module inside your templates, you will
708 experience that the Catalyst server appears to hang while rendering
709 the web page. This is due to the debug mode of L<CGI> (which is
710 waiting for input in the terminal window). Turning off the
711 debug mode using the "-no_debug" option solves the
714 [% USE CGI('-no_debug') %]
718 L<Catalyst>, L<Catalyst::Helper::View::TT>,
719 L<Catalyst::Helper::View::TTSite>, L<Template::Manual>
723 Sebastian Riedel, C<sri@cpan.org>
725 Marcus Ramberg, C<mramberg@cpan.org>
727 Jesse Sheidlower, C<jester@panix.com>
729 Andy Wardley, C<abw@cpan.org>
731 Luke Saunders, C<luke.saunders@gmail.com>
735 This program is free software. You can redistribute it and/or modify it
736 under the same terms as Perl itself.