Catalyst::View::Component::SubInclude::SSI.3pm

Langue: en

Version: 2010-06-10 (fedora - 01/12/10)

Section: 3 (Bibliothèques de fonctions)

NAME

Catalyst::View::Component::SubInclude::SSI - Server Side Includes (SSI) plugin for C::V::Component::SubInclude

VERSION

Version 0.09

SYNOPSIS

In your view class:
   package MyApp::View::TT;
   use Moose;
 
   extends 'Catalyst::View::TT';
   with 'Catalyst::View::Component::SubInclude';
 
   __PACKAGE__->config( subinclude_plugin => 'SSI' );
 
 

Then, somewhere in your templates:

   [% subinclude('/my/widget') %]
 
 

DESCRIPTION

"Catalyst::View::Component::SubInclude::SSI" renders "subinclude" calls as Server Side Includes (SSI) include directives. This is a feature implemented by Apache (<http://httpd.apache.org/>), nginx (<http://wiki.nginx.org/Main>) and many other web servers which allows cache-efficient uses of includes.

CLASS METHODS

generate_subinclude( $c, $path, @args )

Note that $path should be the private action path - translation to the public path is handled internally. After translation, this will roughly translate to the following code:
   my $url = $c->uri_for( $translated_path, @args )->path_query;
   return '<!--#include virtual="$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.

SEE ALSO

Catalyst::View::Component::SubInclude,

AUTHOR

Vladimir Timofeev, "<vovkasm at gmail.com>" This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.