X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FView%2FComponent%2FSubInclude%2FESI.pm;fp=lib%2FCatalyst%2FView%2FComponent%2FSubInclude%2FESI.pm;h=f2b499aba4384d983ef3c6434b271ac6fdce2f61;hb=4e3277560cc20740e2cdb58f4f9cf8eda74c9d73;hp=f2e02b93a3961f3494b4602f60558c82a75231a1;hpb=ada1ae3c160cdae020acd8fa49a3913b8fb7f704;p=catagits%2FCatalyst-View-Component-SubInclude.git

diff --git a/lib/Catalyst/View/Component/SubInclude/ESI.pm b/lib/Catalyst/View/Component/SubInclude/ESI.pm
index f2e02b9..f2b499a 100644
--- a/lib/Catalyst/View/Component/SubInclude/ESI.pm
+++ b/lib/Catalyst/View/Component/SubInclude/ESI.pm
@@ -2,6 +2,56 @@ package Catalyst::View::Component::SubInclude::ESI;
 use warnings;
 use strict;
 
+=head1 NAME
+
+Catalyst::View::Component::SubInclude::ESI - Edge Side Includes (ESI) plugin for C::V::Component::SubInclude
+
+=head1 VERSION
+
+Version 0.01
+
+=cut
+
+our $VERSION = '0.01';
+
+=head1 SYNOPSIS
+
+In your view class:
+
+  package MyApp::View::TT;
+  use Moose;
+
+  extends 'Catalyst::View::TT';
+  with 'Catalyst::View::Component::SubInclude';
+
+  __PACKAGE__->config( subinclude_plugin => 'ESI' );
+
+Then, somewhere in your templates:
+
+  [% subinclude('/my/widget') %]
+
+=head1 DESCRIPTION
+
+C<Catalyst::View::Component::SubInclude::ESI> renders C<subinclude> calls as 
+Edge Side Includes (ESI) include directives. This is a feature implemented by 
+Varnish (L<http://varnish.projects.linpro.no/>) which allows cache-efficient 
+uses of includes.
+
+=head1 STASH FUNCTION
+
+=head2 C<subinclude( @args )>
+
+This will roughly translate to the following code:
+
+  my $url = $c->uri_for( @args );
+  <!--esi <esi:include src="$url" /> -->
+
+Notice that the stash will always be empty. This behavior could be configurable
+in the future through an additional switch - for now, this behavior guarantees a
+common interface for plugins.
+
+=cut
+
 sub generate_subinclude {
     my $class = shift;
     my $c     = shift;
@@ -9,4 +59,29 @@ sub generate_subinclude {
     return '<!--esi <esi:include src="' . $url->path . '" /> -->';
 }
 
+=head1 SEE ALSO
+
+L<Catalyst::View::Component::SubInclude|Catalyst::View::Component::SubInclude>, 
+L<http://www.catalystframework.org/calendar/2008/17>,
+L<http://varnish.projects.linpro.no/>
+
+=head1 AUTHOR
+
+Nilson Santos Figueiredo Junior, C<< <nilsonsfj at cpan.org> >>
+
+=head1 SPONSORSHIP
+
+Development sponsored by Ionzero LLC L<http://www.ionzero.com/>.
+
+=head1 COPYRIGHT & LICENSE
+
+Copyright (C) 2009 Nilson Santos Figueiredo Junior.
+
+Copyright (C) 2009 Ionzero LLC.
+
+This program is free software; you can redistribute it and/or modify it
+under the same terms as Perl itself.
+
+=cut
+
 1;