1 package Catalyst::View::Component::SubInclude::ESI;
3 use namespace::clean -except => 'meta';
7 Catalyst::View::Component::SubInclude::ESI - Edge Side Includes (ESI) plugin for C::V::Component::SubInclude
15 our $VERSION = '0.07_03';
16 $VERSION = eval $VERSION;
22 package MyApp::View::TT;
25 extends 'Catalyst::View::TT';
26 with 'Catalyst::View::Component::SubInclude';
28 __PACKAGE__->config( subinclude_plugin => 'ESI' );
30 Then, somewhere in your templates:
32 [% subinclude('/my/widget') %]
36 C<Catalyst::View::Component::SubInclude::ESI> renders C<subinclude> calls as
37 Edge Side Includes (ESI) include directives. This is a feature implemented by
38 Varnish (L<http://varnish.projects.linpro.no/>) which allows cache-efficient
43 =head2 C<generate_subinclude( $c, $path, @args )>
45 Note that C<$path> should be the private action path - translation to the public
46 path is handled internally. After translation, this will roughly translate to
49 my $url = $c->uri_for( $translated_path, @args )->path_query;
50 return '<!--esi <esi:include src="$url" /> -->';
52 Notice that the stash will always be empty. This behavior could be configurable
53 in the future through an additional switch - for now, this behavior guarantees a
54 common interface for plugins.
58 sub generate_subinclude {
59 my ($self, $c, $path, @params) = @_;
61 my $uri = $c->uri_for_action( $path, @params );
63 return '<!--esi <esi:include src="' . $uri->path_query . '" /> -->';
68 L<Catalyst::View::Component::SubInclude|Catalyst::View::Component::SubInclude>,
69 L<http://www.catalystframework.org/calendar/2008/17>,
70 L<http://varnish.projects.linpro.no/>
74 Nilson Santos Figueiredo Junior, C<< <nilsonsfj at cpan.org> >>
78 Development sponsored by Ionzero LLC L<http://www.ionzero.com/>.
80 =head1 COPYRIGHT & LICENSE
82 Copyright (C) 2009 Nilson Santos Figueiredo Junior.
84 Copyright (C) 2009 Ionzero LLC.
86 This program is free software; you can redistribute it and/or modify it
87 under the same terms as Perl itself.
91 __PACKAGE__->meta->make_immutable;