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


Catalyst-View-Component-SubInclude documentation Contained in the Catalyst-View-Component-SubInclude distribution.

Index


Code Index:

NAME

Top

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

VERSION

Top

Version 0.10

SYNOPSIS

Top

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

Top

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.

METHODS

Top

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

Top

Catalyst::View::Component::SubInclude,

AUTHOR

Top

Vladimir Timofeev, <vovkasm at gmail.com>

COPYRIGHT & LICENSE

Top


Catalyst-View-Component-SubInclude documentation Contained in the Catalyst-View-Component-SubInclude distribution.
package Catalyst::View::Component::SubInclude::SSI;
use Moose;
use namespace::clean -except => 'meta';

our $VERSION = '0.10';
$VERSION = eval $VERSION;

sub generate_subinclude {
    my ($self, $c, $path, @params) = @_;

    my $uri = $c->uri_for_action( $path, @params );

    return '<!--#include virtual="' . $uri->path_query . '" -->';
}

__PACKAGE__->meta->make_immutable;
1;