1 package Catalyst::View::Component::SubInclude::ESI;
7 Catalyst::View::Component::SubInclude::ESI - Edge Side Includes (ESI) plugin for C::V::Component::SubInclude
15 our $VERSION = '0.04';
21 package MyApp::View::TT;
24 extends 'Catalyst::View::TT';
25 with 'Catalyst::View::Component::SubInclude';
27 __PACKAGE__->config( subinclude_plugin => 'ESI' );
29 Then, somewhere in your templates:
31 [% subinclude('/my/widget') %]
35 C<Catalyst::View::Component::SubInclude::ESI> renders C<subinclude> calls as
36 Edge Side Includes (ESI) include directives. This is a feature implemented by
37 Varnish (L<http://varnish.projects.linpro.no/>) which allows cache-efficient
42 =head2 C<generate_subinclude( $c, $path, @args )>
44 Note that C<$path> should be the private action path - translation to the public
45 path is handled internally. After translation, this will roughly translate to
48 my $url = $c->uri_for( $translated_path, @args )->path_query;
49 return '<!--esi <esi:include src="$url" /> -->';
51 Notice that the stash will always be empty. This behavior could be configurable
52 in the future through an additional switch - for now, this behavior guarantees a
53 common interface for plugins.
57 sub generate_subinclude {
58 my ($class, $c, $path, @params) = @_;
60 my $args = ref $params[0] eq 'ARRAY' ? shift @params : [];
62 my $dispatcher = $c->dispatcher;
63 my ($action) = $dispatcher->_invoke_as_path( $c, $path, $args );
65 my $uri = $c->uri_for( $action, $args, @params );
67 return '<!--esi <esi:include src="' . $uri->path_query . '" /> -->';
72 L<Catalyst::View::Component::SubInclude|Catalyst::View::Component::SubInclude>,
73 L<http://www.catalystframework.org/calendar/2008/17>,
74 L<http://varnish.projects.linpro.no/>
78 Nilson Santos Figueiredo Junior, C<< <nilsonsfj at cpan.org> >>
82 Development sponsored by Ionzero LLC L<http://www.ionzero.com/>.
84 =head1 COPYRIGHT & LICENSE
86 Copyright (C) 2009 Nilson Santos Figueiredo Junior.
88 Copyright (C) 2009 Ionzero LLC.
90 This program is free software; you can redistribute it and/or modify it
91 under the same terms as Perl itself.