1 package Catalyst::View::TT;
4 use base qw/Catalyst::View/;
11 __PACKAGE__->mk_accessors('template');
12 __PACKAGE__->mk_accessors('include_path');
16 Catalyst::View::TT - Template View Class
20 # use the helper to create View
21 myapp_create.pl view TT TT
23 # configure in lib/MyApp.pm
27 root => MyApp->path_to('root');,
29 # any TT configurations items go here
31 MyApp->path_to( 'root', 'src' ),
32 MyApp->path_to( 'root', 'lib' ),
34 PRE_PROCESS => 'config/main',
35 WRAPPER => 'site/wrapper',
36 TEMPLATE_EXTENSION => '.tt',
38 # two optional config items
39 CATALYST_VAR => 'Catalyst',
44 # render view from lib/MyApp.pm or lib/MyApp::C::SomeController.pm
46 sub message : Global {
47 my ( $self, $c ) = @_;
48 $c->stash->{template} = 'message.tt2';
49 $c->stash->{message} = 'Hello World!';
50 $c->forward('MyApp::V::TT');
53 # access variables from template
55 The message is: [% message %].
57 # example when CATALYST_VAR is set to 'Catalyst'
58 Context is [% Catalyst %]
59 The base is [% Catalyst.req.base %]
60 The name is [% Catalyst.config.name %]
62 # example when CATALYST_VAR isn't set
64 The base is [% base %]
65 The name is [% name %]
69 This is the Catalyst view class for the L<Template Toolkit|Template>.
70 Your application should defined a view class which is a subclass of
71 this module. The easiest way to achieve this is using the
72 F<myapp_create.pl> script (where F<myapp> should be replaced with
73 whatever your application is called). This script is created as part
74 of the Catalyst setup.
76 $ script/myapp_create.pl view TT TT
78 This creates a MyApp::V::TT.pm module in the F<lib> directory (again,
79 replacing C<MyApp> with the name of your application) which looks
82 package FooBar::V::TT;
85 use base 'Catalyst::View::TT';
87 __PACKAGE__->config->{DEBUG} = 'all';
89 Now you can modify your action handlers in the main application and/or
90 controllers to forward to your view class. You might choose to do this
91 in the end() method, for example, to automatically forward all actions
94 # In MyApp or MyApp::Controller::SomeController
98 $c->forward('MyApp::V::TT');
103 There are a three different ways to configure your view class. The
104 first way is to call the C<config()> method in the view subclass. This
105 happens when the module is first loaded.
107 package MyApp::V::TT;
110 use base 'Catalyst::View::TT';
112 MyApp::V::TT->config({
114 MyApp->path_to( 'root', 'templates', 'lib' ),
115 MyApp->path_to( 'root', 'templates', 'src' ),
117 PRE_PROCESS => 'config/main',
118 WRAPPER => 'site/wrapper',
121 The second way is to define a C<new()> method in your view subclass.
122 This performs the configuration when the view object is created,
123 shortly after being loaded. Remember to delegate to the base class
124 C<new()> method (via C<$self-E<gt>NEXT::new()> in the example below) after
125 performing any configuration.
131 MyApp->path_to( 'root', 'templates', 'lib' ),
132 MyApp->path_to( 'root', 'templates', 'src' ),
134 PRE_PROCESS => 'config/main',
135 WRAPPER => 'site/wrapper',
137 return $self->NEXT::new(@_);
140 The final, and perhaps most direct way, is to define a class
141 item in your main application configuration, again by calling the
142 uniquitous C<config()> method. The items in the class hash are
143 added to those already defined by the above two methods. This happens
144 in the base class new() method (which is one reason why you must
145 remember to call it via C<NEXT> if you redefine the C<new()> method in a
155 root => MyApp->path_to('root'),
158 MyApp->path_to( 'root', 'templates', 'lib' ),
159 MyApp->path_to( 'root', 'templates', 'src' ),
161 PRE_PROCESS => 'config/main',
162 WRAPPER => 'site/wrapper',
166 Note that any configuration items defined by one of the earlier
167 methods will be overwritten by items of the same name provided by the
170 =head2 DYNAMIC INCLUDE_PATH
172 It is sometimes needed to dynamically add additional paths to the
173 INCLUDE_PATH variable of the template object. This can be done by setting
174 'additional_include_paths' on stash to a referrence to an array with
177 $c->stash->{additional_template_paths} = [$c->config->{root} . '/test_include_path'];
179 =head2 RENDERING VIEWS
181 The view plugin renders the template specified in the C<template>
184 sub message : Global {
185 my ( $self, $c ) = @_;
186 $c->stash->{template} = 'message.tt2';
187 $c->forward('MyApp::V::TT');
190 If a class item isn't defined, then it instead uses the
191 current match, as returned by C<$c-E<gt>match>. In the above
192 example, this would be C<message>.
194 The items defined in the stash are passed to the Template Toolkit for
195 use as template variables.
197 sub message : Global {
198 sub default : Private {
199 my ( $self, $c ) = @_;
200 $c->stash->{template} = 'message.tt2';
201 $c->stash->{message} = 'Hello World!';
202 $c->forward('MyApp::V::TT');
205 A number of other template variables are also added:
207 c A reference to the context object, $c
208 base The URL base, from $c->req->base()
209 name The application name, from $c->config->{ name }
211 These can be accessed from the template in the usual way:
215 The message is: [% message %]
216 The base is [% base %]
217 The name is [% name %]
220 The output generated by the template is stored in
221 C<$c-E<gt>response-E<gt>output>.
223 =head2 TEMPLATE PROFILING
231 The constructor for the TT view. Sets up the template provider,
232 and reads the application config.
237 my ( $paths, $dlim ) = shift;
238 return () if ( ! $paths );
239 return @{$paths} if ( ref $paths eq 'ARRAY');
241 # tweak delim to ignore C:/
242 unless (defined $dlim) {
243 $dlim = ($^O eq 'MSWin32') ? ':(?!\\/)' : ':';
245 return split(/$dlim/, $paths);
251 my ( $class, $c, $arguments ) = @_;
252 my $delim = $class->config->{DELIMITER} || $arguments->{DELIMITER};
253 my @include_path = _coerce_paths($arguments->{INCLUDE_PATH}, $delim);
255 @include_path = _coerce_paths($class->config->{INCLUDE_PATH}, $delim);
258 my $root = $c->config->{root};
259 my $base = Path::Class::dir($root, 'base');
260 @include_path = ( "$root", "$base" );
264 TEMPLATE_EXTENSION => '',
267 INCLUDE_PATH => \@include_path,
270 # if we're debugging and/or the TIMER option is set, then we install
271 # Template::Timer as a custom CONTEXT object, but only if we haven't
272 # already got a custom CONTEXT defined
274 if ( $config->{TIMER} ) {
275 if ( $config->{CONTEXT} ) {
277 'Cannot use Template::Timer - a TT CONFIG is already defined');
280 $config->{CONTEXT} = Template::Timer->new(%$config);
284 if ( $c->debug && $config->{DUMP_CONFIG} ) {
286 $c->log->debug( "TT Config: ", Dumper($config) );
289 my $self = $class->NEXT::new(
292 template => Template->new($config) || do {
293 my $error = Template->error();
294 $c->log->error($error);
301 $self->include_path(\@include_path);
302 $self->config($config);
309 Renders the template specified in C<$c-E<gt>stash-E<gt>{template}> or
310 C<$c-E<gt>request-E<gt>match>. Template variables are set up from the
311 contents of C<$c-E<gt>stash>, augmented with C<base> set to
312 C<$c-E<gt>req-E<gt>base>, C<c> to C<$c> and C<name> to
313 C<$c-E<gt>config-E<gt>{name}>. Alternately, the C<CATALYST_VAR>
314 configuration item can be defined to specify the name of a template
315 variable through which the context reference (C<$c>) can be accessed.
316 In this case, the C<c>, C<base> and C<name> variables are omitted.
317 Output is stored in C<$c-E<gt>response-E<gt>output>.
322 my ( $self, $c ) = @_;
324 my $template = $c->stash->{template}
325 || $c->request->match . $self->config->{TEMPLATE_EXTENSION};
328 $c->log->debug('No template specified for rendering') if $c->debug;
332 $c->log->debug(qq/Rendering template "$template"/) if $c->debug;
335 my $cvar = $self->config->{CATALYST_VAR};
341 base => $c->req->base,
342 name => $c->config->{name}
347 my @tmp_path = @{$self->include_path};
348 unshift @{$self->include_path}, @{$c->stash->{additional_template_paths}} if ref $c->stash->{additional_template_paths};
349 unless ( $self->template->process( $template, $vars, \$output ) ) {
350 my $error = $self->template->error;
351 $error = qq/Couldn't render template "$error"/;
352 $c->log->error($error);
356 @{$self->include_path} = @tmp_path if ref $c->stash->{additional_template_paths};
358 unless ( $c->response->content_type ) {
359 $c->response->content_type('text/html; charset=utf-8');
362 $c->response->body($output);
369 This method allows your view subclass to pass additional settings to
370 the TT configuration hash, or to set the options as below:
374 =item C<CATALYST_VAR>
376 Allows you to change the name of the Catalyst context object. If set, it will also
377 remove the base and name aliases, so you will have access them through <context>.
383 root => MyApp->path_to('root'),
385 CATALYST_VAR => 'Catalyst',
391 The base is [% Catalyst.req.base %]
392 The name is [% Catalyst.config.name %]
396 If you have configured Catalyst for debug output, and turned on the TIMER setting,
397 C<Catalyst::View::TT> will enable profiling of template processing
398 (using L<Template::Timer>). This will embed HTML comments in the
399 output from your templates, such as:
401 <!-- TIMER START: process mainmenu/mainmenu.ttml -->
402 <!-- TIMER START: include mainmenu/cssindex.tt -->
403 <!-- TIMER START: process mainmenu/cssindex.tt -->
404 <!-- TIMER END: process mainmenu/cssindex.tt (0.017279 seconds) -->
405 <!-- TIMER END: include mainmenu/cssindex.tt (0.017401 seconds) -->
409 <!-- TIMER END: process mainmenu/footer.tt (0.003016 seconds) -->
412 =item C<TEMPLATE_EXTENSION>
414 a sufix to add when looking for templates bases on the C<match> method in L<Catalyst::Request>.
418 package MyApp::C::Test;
419 sub test : Local { .. }
421 Would by default look for a template in <root>/test/test. If you set TEMPLATE_EXTENSION to '.tt', it will look for
430 The L<Catalyst::Helper::View::TT> and
431 L<Catalyst::Helper::View::TTSite> helper modules are provided to create
432 your view module. There are invoked by the F<myapp_create.pl> script:
434 $ script/myapp_create.pl view TT TT
436 $ script/myapp_create.pl view TT TTSite
438 The L<Catalyst::Helper::View::TT> module creates a basic TT view
439 module. The L<Catalyst::Helper::View::TTSite> module goes a little
440 further. It also creates a default set of templates to get you
441 started. It also configures the view module to locate the templates
446 L<Catalyst>, L<Catalyst::Helper::View::TT>,
447 L<Catalyst::Helper::View::TTSite>, L<Template::Manual>
451 Sebastian Riedel, C<sri@cpan.org>
453 Marcus Ramberg, C<mramberg@cpan.org>
455 Jesse Sheidlower, C<jester@panix.com>
457 Andy Wardley, C<abw@cpan.org>
461 This program is free software, you can redistribute it and/or modify it
462 under the same terms as Perl itself.