1 package Catalyst::View::TT;
4 use base qw/Catalyst::View/;
11 __PACKAGE__->mk_accessors('template');
12 __PACKAGE__->mk_accessors('include_path');
14 *paths = \&include_path;
18 Catalyst::View::TT - Template View Class
22 # use the helper to create View
23 myapp_create.pl view TT TT
25 # configure in lib/MyApp.pm
29 root => MyApp->path_to('root');,
31 # any TT configurations items go here
33 MyApp->path_to( 'root', 'src' ),
34 MyApp->path_to( 'root', 'lib' ),
36 PRE_PROCESS => 'config/main',
37 WRAPPER => 'site/wrapper',
38 TEMPLATE_EXTENSION => '.tt',
40 # two optional config items
41 CATALYST_VAR => 'Catalyst',
46 # render view from lib/MyApp.pm or lib/MyApp::C::SomeController.pm
48 sub message : Global {
49 my ( $self, $c ) = @_;
50 $c->stash->{template} = 'message.tt2';
51 $c->stash->{message} = 'Hello World!';
52 $c->forward('MyApp::V::TT');
55 # access variables from template
57 The message is: [% message %].
59 # example when CATALYST_VAR is set to 'Catalyst'
60 Context is [% Catalyst %]
61 The base is [% Catalyst.req.base %]
62 The name is [% Catalyst.config.name %]
64 # example when CATALYST_VAR isn't set
66 The base is [% base %]
67 The name is [% name %]
71 This is the Catalyst view class for the L<Template Toolkit|Template>.
72 Your application should defined a view class which is a subclass of
73 this module. The easiest way to achieve this is using the
74 F<myapp_create.pl> script (where F<myapp> should be replaced with
75 whatever your application is called). This script is created as part
76 of the Catalyst setup.
78 $ script/myapp_create.pl view TT TT
80 This creates a MyApp::V::TT.pm module in the F<lib> directory (again,
81 replacing C<MyApp> with the name of your application) which looks
84 package FooBar::V::TT;
87 use base 'Catalyst::View::TT';
89 __PACKAGE__->config->{DEBUG} = 'all';
91 Now you can modify your action handlers in the main application and/or
92 controllers to forward to your view class. You might choose to do this
93 in the end() method, for example, to automatically forward all actions
96 # In MyApp or MyApp::Controller::SomeController
100 $c->forward('MyApp::V::TT');
105 There are a three different ways to configure your view class. The
106 first way is to call the C<config()> method in the view subclass. This
107 happens when the module is first loaded.
109 package MyApp::V::TT;
112 use base 'Catalyst::View::TT';
114 MyApp::V::TT->config({
116 MyApp->path_to( 'root', 'templates', 'lib' ),
117 MyApp->path_to( 'root', 'templates', 'src' ),
119 PRE_PROCESS => 'config/main',
120 WRAPPER => 'site/wrapper',
123 The second way is to define a C<new()> method in your view subclass.
124 This performs the configuration when the view object is created,
125 shortly after being loaded. Remember to delegate to the base class
126 C<new()> method (via C<$self-E<gt>NEXT::new()> in the example below) after
127 performing any configuration.
133 MyApp->path_to( 'root', 'templates', 'lib' ),
134 MyApp->path_to( 'root', 'templates', 'src' ),
136 PRE_PROCESS => 'config/main',
137 WRAPPER => 'site/wrapper',
139 return $self->NEXT::new(@_);
142 The final, and perhaps most direct way, is to define a class
143 item in your main application configuration, again by calling the
144 uniquitous C<config()> method. The items in the class hash are
145 added to those already defined by the above two methods. This happens
146 in the base class new() method (which is one reason why you must
147 remember to call it via C<NEXT> if you redefine the C<new()> method in a
157 root => MyApp->path_to('root'),
160 MyApp->path_to( 'root', 'templates', 'lib' ),
161 MyApp->path_to( 'root', 'templates', 'src' ),
163 PRE_PROCESS => 'config/main',
164 WRAPPER => 'site/wrapper',
168 Note that any configuration items defined by one of the earlier
169 methods will be overwritten by items of the same name provided by the
172 =head2 DYNAMIC INCLUDE_PATH
174 Sometimes it is desirable to modify INCLUDE_PATH for your templates at run time.
176 Additional paths can be added to the start of INCLUDE_PATH via the stash as
179 $c->stash->{additional_template_paths} =
180 [$c->config->{root} . '/test_include_path'];
182 If you need to add paths to the end of INCLUDE_PATH, there is also an
183 include_path() accessor available:
185 push( @{ $c->view('TT')->include_path }, qw/path/ );
187 Note that if you use include_path() to add extra paths to INCLUDE_PATH, you
188 MUST check for duplicate paths. Without such checking, the above code will add
189 "path" to INCLUDE_PATH at every request, causing a memory leak.
191 A safer approach is to use include_path() to overwrite the array of paths
192 rather than adding to it. This eliminates both the need to perform duplicate
193 checking and the chance of a memory leak:
195 @{ $c->view('TT')->include_path } = qw/path another_path/;
197 If you are calling C<render> directly then you can specify dynamic paths by
198 having a C<additional_template_paths> key with a value of additonal directories
199 to search. See L<CAPTURING TEMPLATE OUTPUT> for an example showing this.
201 =head2 RENDERING VIEWS
203 The view plugin renders the template specified in the C<template>
206 sub message : Global {
207 my ( $self, $c ) = @_;
208 $c->stash->{template} = 'message.tt2';
209 $c->forward('MyApp::V::TT');
212 If a class item isn't defined, then it instead uses the
213 current match, as returned by C<< $c->match >>. In the above
214 example, this would be C<message>.
216 The items defined in the stash are passed to the Template Toolkit for
217 use as template variables.
219 sub default : Private {
220 my ( $self, $c ) = @_;
221 $c->stash->{template} = 'message.tt2';
222 $c->stash->{message} = 'Hello World!';
223 $c->forward('MyApp::V::TT');
226 A number of other template variables are also added:
228 c A reference to the context object, $c
229 base The URL base, from $c->req->base()
230 name The application name, from $c->config->{ name }
232 These can be accessed from the template in the usual way:
236 The message is: [% message %]
237 The base is [% base %]
238 The name is [% name %]
241 The output generated by the template is stored in C<< $c->response->body >>.
243 =head2 CAPTURING TEMPLATE OUTPUT
245 If you wish to use the output of a template for some other purpose than
246 displaying in the response, e.g. for sending an email, this is possible using
247 L<Catalyst::Plugin::Email> and the L<render> method:
249 sub send_email : Local {
254 To => 'me@localhost',
255 Subject => 'A TT Email',
257 body => $c->view('TT')->render($c, 'email.tt', {
258 additional_template_paths => [ $c->config->{root} . '/email_templates'],
259 email_tmpl_param1 => 'foo'
263 # Redirect or display a message
266 =head2 TEMPLATE PROFILING
268 See L<C<TIMER>> property of the L<config> method.
276 The constructor for the TT view. Sets up the template provider,
277 and reads the application config.
282 my ( $paths, $dlim ) = shift;
283 return () if ( !$paths );
284 return @{$paths} if ( ref $paths eq 'ARRAY' );
286 # tweak delim to ignore C:/
287 unless ( defined $dlim ) {
288 $dlim = ( $^O eq 'MSWin32' ) ? ':(?!\\/)' : ':';
290 return split( /$dlim/, $paths );
294 my ( $class, $c, $arguments ) = @_;
297 TEMPLATE_EXTENSION => '',
301 if ( ! (ref $config->{INCLUDE_PATH} eq 'ARRAY') ) {
302 my $delim = $config->{DELIMITER};
304 = _coerce_paths( $config->{INCLUDE_PATH}, $delim );
305 if ( !@include_path ) {
306 my $root = $c->config->{root};
307 my $base = Path::Class::dir( $root, 'base' );
308 @include_path = ( "$root", "$base" );
310 $config->{INCLUDE_PATH} = \@include_path;
315 # if we're debugging and/or the TIMER option is set, then we install
316 # Template::Timer as a custom CONTEXT object, but only if we haven't
317 # already got a custom CONTEXT defined
319 if ( $config->{TIMER} ) {
320 if ( $config->{CONTEXT} ) {
322 'Cannot use Template::Timer - a TT CONTEXT is already defined'
326 $config->{CONTEXT} = Template::Timer->new(%$config);
330 if ( $c->debug && $config->{DUMP_CONFIG} ) {
332 $c->log->debug( "TT Config: ", Dumper($config) );
334 if ( $config->{PROVIDERS} ) {
336 if ( ref($config->{PROVIDERS}) eq 'ARRAY') {
337 foreach my $p (@{$config->{PROVIDERS}}) {
338 my $pname = $p->{name};
339 eval "require Template::Provider::$pname";
341 push @providers, "Template::Provider::${pname}"->new($p->{args});
345 delete $config->{PROVIDERS};
347 $config->{LOAD_TEMPLATES} = \@providers;
351 my $self = $class->NEXT::new(
355 # Set base include paths. Local'd in render if needed
356 $self->include_path($config->{INCLUDE_PATH});
358 $self->config($config);
360 # Creation of template outside of call to new so that we can pass [ $self ]
361 # as INCLUDE_PATH config item, which then gets ->paths() called to get list
362 # of include paths to search for templates.
364 # Use a weakend copy of self so we dont have loops preventing GC from working
366 Scalar::Util::weaken($copy);
367 $config->{INCLUDE_PATH} = [ sub { $copy->paths } ];
370 Template->new($config) || do {
371 my $error = Template->error();
372 $c->log->error($error);
383 Renders the template specified in C<< $c->stash->{template} >> or
384 C<< $c->action >> (the private name of the matched action. Calls L<render> to
385 perform actual rendering. Output is stored in C<< $c->response->body >>.
390 my ( $self, $c ) = @_;
392 my $template = $c->stash->{template}
393 || $c->action . $self->config->{TEMPLATE_EXTENSION};
396 $c->log->debug('No template specified for rendering') if $c->debug;
400 my $output = $self->render($c, $template);
402 if (UNIVERSAL::isa($output, 'Template::Exception')) {
403 my $error = qq/Coldn't render template "$output"/;
404 $c->log->error($error);
409 unless ( $c->response->content_type ) {
410 $c->response->content_type('text/html; charset=utf-8');
413 $c->response->body($output);
418 =item render($c, $template, \%args)
420 Renders the given template and returns output, or a L<Template::Exception>
423 The template variables are set to C<%$args> if $args is a hashref, or
424 $C<< $c->stash >> otherwise. In either case the variables are augmented with
425 C<base> set to C< << $c->req->base >>, C<c> to C<$c> and C<name> to
426 C<< $c->config->{name} >>. Alternately, the C<CATALYST_VAR> configuration item
427 can be defined to specify the name of a template variable through which the
428 context reference (C<$c>) can be accessed. In this case, the C<c>, C<base> and
429 C<name> variables are omitted.
431 C<$template> can be anything that Template::process understands how to
432 process, including the name of a template file or a reference to a test string.
433 See L<Template::process|Template/process> for a full list of supported formats.
438 my ($self, $c, $template, $args) = @_;
440 $c->log->debug(qq/Rendering template "$template"/) if $c->debug;
444 (ref $args eq 'HASH' ? %$args : %{ $c->stash() }),
445 $self->template_vars($c)
448 local $self->{include_path} =
449 [ @{ $vars->{additional_template_paths} }, @{ $self->{include_path} } ]
450 if ref $vars->{additional_template_paths};
452 unless ($self->template->process( $template, $vars, \$output ) ) {
453 return $self->template->error;
461 Returns a list of keys/values to be used as the catalyst variables in the
467 my ( $self, $c ) = @_;
469 my $cvar = $self->config->{CATALYST_VAR};
475 base => $c->req->base,
476 name => $c->config->{name}
482 This method allows your view subclass to pass additional settings to
483 the TT configuration hash, or to set the options as below:
487 =item C<CATALYST_VAR>
489 Allows you to change the name of the Catalyst context object. If set, it will also
490 remove the base and name aliases, so you will have access them through <context>.
496 root => MyApp->path_to('root'),
498 CATALYST_VAR => 'Catalyst',
504 The base is [% Catalyst.req.base %]
505 The name is [% Catalyst.config.name %]
509 If you have configured Catalyst for debug output, and turned on the TIMER setting,
510 C<Catalyst::View::TT> will enable profiling of template processing
511 (using L<Template::Timer>). This will embed HTML comments in the
512 output from your templates, such as:
514 <!-- TIMER START: process mainmenu/mainmenu.ttml -->
515 <!-- TIMER START: include mainmenu/cssindex.tt -->
516 <!-- TIMER START: process mainmenu/cssindex.tt -->
517 <!-- TIMER END: process mainmenu/cssindex.tt (0.017279 seconds) -->
518 <!-- TIMER END: include mainmenu/cssindex.tt (0.017401 seconds) -->
522 <!-- TIMER END: process mainmenu/footer.tt (0.003016 seconds) -->
525 =item C<TEMPLATE_EXTENSION>
527 a sufix to add when looking for templates bases on the C<match> method in L<Catalyst::Request>.
531 package MyApp::C::Test;
532 sub test : Local { .. }
534 Would by default look for a template in <root>/test/test. If you set TEMPLATE_EXTENSION to '.tt', it will look for
543 The L<Catalyst::Helper::View::TT> and
544 L<Catalyst::Helper::View::TTSite> helper modules are provided to create
545 your view module. There are invoked by the F<myapp_create.pl> script:
547 $ script/myapp_create.pl view TT TT
549 $ script/myapp_create.pl view TT TTSite
551 The L<Catalyst::Helper::View::TT> module creates a basic TT view
552 module. The L<Catalyst::Helper::View::TTSite> module goes a little
553 further. It also creates a default set of templates to get you
554 started. It also configures the view module to locate the templates
559 L<Catalyst>, L<Catalyst::Helper::View::TT>,
560 L<Catalyst::Helper::View::TTSite>, L<Template::Manual>
564 Sebastian Riedel, C<sri@cpan.org>
566 Marcus Ramberg, C<mramberg@cpan.org>
568 Jesse Sheidlower, C<jester@panix.com>
570 Andy Wardley, C<abw@cpan.org>
574 This program is free software, you can redistribute it and/or modify it
575 under the same terms as Perl itself.