Commit | Line | Data |
30726632 |
1 | package Catalyst::View::Component::SubInclude::ESI; |
2 | use warnings; |
3 | use strict; |
4 | |
4e327756 |
5 | =head1 NAME |
6 | |
7 | Catalyst::View::Component::SubInclude::ESI - Edge Side Includes (ESI) plugin for C::V::Component::SubInclude |
8 | |
9 | =head1 VERSION |
10 | |
e88af283 |
11 | Version 0.02 |
4e327756 |
12 | |
13 | =cut |
14 | |
e88af283 |
15 | our $VERSION = '0.02'; |
4e327756 |
16 | |
17 | =head1 SYNOPSIS |
18 | |
19 | In your view class: |
20 | |
21 | package MyApp::View::TT; |
22 | use Moose; |
23 | |
24 | extends 'Catalyst::View::TT'; |
25 | with 'Catalyst::View::Component::SubInclude'; |
26 | |
27 | __PACKAGE__->config( subinclude_plugin => 'ESI' ); |
28 | |
29 | Then, somewhere in your templates: |
30 | |
31 | [% subinclude('/my/widget') %] |
32 | |
33 | =head1 DESCRIPTION |
34 | |
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 |
38 | uses of includes. |
39 | |
11a93ea1 |
40 | =head1 CLASS METHODS |
4e327756 |
41 | |
11a93ea1 |
42 | =head2 C<generate_subinclude( $c, @args )> |
4e327756 |
43 | |
44 | This will roughly translate to the following code: |
45 | |
46 | my $url = $c->uri_for( @args ); |
11a93ea1 |
47 | return '<!--esi <esi:include src="$url" /> -->'; |
4e327756 |
48 | |
49 | Notice that the stash will always be empty. This behavior could be configurable |
50 | in the future through an additional switch - for now, this behavior guarantees a |
51 | common interface for plugins. |
52 | |
53 | =cut |
54 | |
30726632 |
55 | sub generate_subinclude { |
56 | my $class = shift; |
57 | my $c = shift; |
58 | my $url = $c->uri_for( @_ ); |
59 | return '<!--esi <esi:include src="' . $url->path . '" /> -->'; |
60 | } |
61 | |
4e327756 |
62 | =head1 SEE ALSO |
63 | |
64 | L<Catalyst::View::Component::SubInclude|Catalyst::View::Component::SubInclude>, |
65 | L<http://www.catalystframework.org/calendar/2008/17>, |
66 | L<http://varnish.projects.linpro.no/> |
67 | |
68 | =head1 AUTHOR |
69 | |
70 | Nilson Santos Figueiredo Junior, C<< <nilsonsfj at cpan.org> >> |
71 | |
72 | =head1 SPONSORSHIP |
73 | |
74 | Development sponsored by Ionzero LLC L<http://www.ionzero.com/>. |
75 | |
76 | =head1 COPYRIGHT & LICENSE |
77 | |
78 | Copyright (C) 2009 Nilson Santos Figueiredo Junior. |
79 | |
80 | Copyright (C) 2009 Ionzero LLC. |
81 | |
82 | This program is free software; you can redistribute it and/or modify it |
83 | under the same terms as Perl itself. |
84 | |
85 | =cut |
86 | |
30726632 |
87 | 1; |