'View::TT' => {
# any TT configurations items go here
INCLUDE_PATH => [
- MyApp->path_to( 'root', 'src' ),
- MyApp->path_to( 'root', 'lib' ),
+ MyApp->path_to( 'root', 'src' ),
+ MyApp->path_to( 'root', 'lib' ),
],
TEMPLATE_EXTENSION => '.tt',
CATALYST_VAR => 'c',
WRAPPER => 'site/wrapper',
},
);
-
+
# render view from lib/MyApp.pm or lib/MyApp::Controller::SomeController.pm
-
+
sub message : Global {
my ( $self, $c ) = @_;
$c->stash->{template} = 'message.tt2';
# access variables from template
The message is: [% message %].
-
+
# example when CATALYST_VAR is set to 'Catalyst'
- Context is [% Catalyst %]
- The base is [% Catalyst.req.base %]
- The name is [% Catalyst.config.name %]
-
+ Context is [% Catalyst %]
+ The base is [% Catalyst.req.base %]
+ The name is [% Catalyst.config.name %]
+
# example when CATALYST_VAR isn't set
Context is [% c %]
The base is [% base %]
}
my $self = $class->next::method(
- $c, { %$config },
+ $c, { %$config },
);
# Set base include paths. Local'd in render if needed
$self->include_path($config->{INCLUDE_PATH});
-
+
$self->config($config);
# Creation of template outside of call to new so that we can pass [ $self ]
# as INCLUDE_PATH config item, which then gets ->paths() called to get list
# of include paths to search for templates.
-
+
# Use a weakend copy of self so we dont have loops preventing GC from working
my $copy = $self;
Scalar::Util::weaken($copy);
$config->{LOAD_TEMPLATES} = \@providers;
}
}
-
- $self->{template} =
+
+ $self->{template} =
Template->new($config) || do {
my $error = Template->error();
$c->log->error($error);
$c->log->debug(qq/Rendering template "$template"/) if $c->debug;
my $output;
- my $vars = {
+ my $vars = {
(ref $args eq 'HASH' ? %$args : %{ $c->stash() }),
$self->template_vars($c)
};
- local $self->{include_path} =
+ local $self->{include_path} =
[ @{ $vars->{additional_template_paths} }, @{ $self->{include_path} } ]
if ref $vars->{additional_template_paths};
unless ($self->template->process( $template, $vars, \$output ) ) {
- return $self->template->error;
+ return $self->template->error;
} else {
return $output;
}
something like this:
package FooBar::View::TT;
-
+
use strict;
use warnings;
-
+
use base 'Catalyst::View::TT';
__PACKAGE__->config->{DEBUG} = 'all';
to the TT view class.
# In MyApp or MyApp::Controller::SomeController
-
+
sub end : Private {
my( $self, $c ) = @_;
$c->forward( $c->view('TT') );
happens when the module is first loaded.
package MyApp::View::TT;
-
+
use strict;
use base 'Catalyst::View::TT';
});
return $self->next::method(@_);
}
-
+
The final, and perhaps most direct way, is to define a class
item in your main application configuration, again by calling the
ubiquitous C<config()> method. The items in the class hash are
added to those already defined by the above two methods. This happens
in the base class new() method (which is one reason why you must
-remember to call it via C<MRO::Compat> if you redefine the C<new()>
+remember to call it via C<MRO::Compat> if you redefine the C<new()>
method in a subclass).
package MyApp;
-
+
use strict;
use Catalyst;
-
+
MyApp->config({
name => 'MyApp',
root => MyApp->path_to('root'),
Note that any configuration items defined by one of the earlier
methods will be overwritten by items of the same name provided by the
-latter methods.
+latter methods.
=head2 DYNAMIC INCLUDE_PATH
Sometimes it is desirable to modify INCLUDE_PATH for your templates at run time.
-
+
Additional paths can be added to the start of INCLUDE_PATH via the stash as
follows:
@{ $c->view('TT')->include_path } = qw/path another_path/;
-If you are calling C<render> directly then you can specify dynamic paths by
+If you are calling C<render> directly then you can specify dynamic paths by
having a C<additional_template_paths> key with a value of additonal directories
to search. See L<CAPTURING TEMPLATE OUTPUT> for an example showing this.
=head2 RENDERING VIEWS
The view plugin renders the template specified in the C<template>
-item in the stash.
+item in the stash.
sub message : Global {
my ( $self, $c ) = @_;
sub send_email : Local {
my ($self, $c) = @_;
-
+
$c->email(
header => [
To => 'me@localhost',
=head2 new
-The constructor for the TT view. Sets up the template provider,
+The constructor for the TT view. Sets up the template provider,
and reads the application config.
=head2 process
=head2 render($c, $template, \%args)
Renders the given template and returns output, or a L<Template::Exception>
-object upon error.
+object upon error.
-The template variables are set to C<%$args> if $args is a hashref, or
-$C<< $c->stash >> otherwise. In either case the variables are augmented with
+The template variables are set to C<%$args> if $args is a hashref, or
+$C<< $c->stash >> otherwise. In either case the variables are augmented with
C<base> set to C< << $c->req->base >>, C<c> to C<$c> and C<name> to
C<< $c->config->{name} >>. Alternately, the C<CATALYST_VAR> configuration item
can be defined to specify the name of a template variable through which the
context reference (C<$c>) can be accessed. In this case, the C<c>, C<base> and
C<name> variables are omitted.
-C<$template> can be anything that Template::process understands how to
+C<$template> can be anything that Template::process understands how to
process, including the name of a template file or a reference to a test string.
See L<Template::process|Template/process> for a full list of supported formats.
The list of paths TT will look for templates in.
-=head2 C<CATALYST_VAR>
+=head2 C<CATALYST_VAR>
Allows you to change the name of the Catalyst context object. If set, it will also
remove the base and name aliases, so you will have access them through <context>.
For example:
package MyApp::Controller::Test;
- sub test : Local { .. }
+ sub test : Local { .. }
Would by default look for a template in <root>/test/test. If you set TEMPLATE_EXTENSION to '.tt', it will look for
<root>/test/test.tt.
You can also specify the 'copy_config' key as an arrayref, to copy those keys
from the general config, into the config for the provider:
-
+
DEFAULT_ENCODING => 'utf-8',
PROVIDERS => [
{
copy_config => [qw(DEFAULT_ENCODING INCLUDE_PATH)]
}
]
-
+
This can prove useful when you want to use the additional_template_paths hack
in your own provider, or if you need to use Template::Provider::Encoding
=head1 COPYRIGHT
-This program is free software. You can redistribute it and/or modify it
+This program is free software. You can redistribute it and/or modify it
under the same terms as Perl itself.
=cut
projects / catagits/Catalyst-View-TT.git / commitdiff