Cataly...e::SSI(3pm)

💖 Catalyst::View::Component::SubInclude::SSI 💖

okay bestie, welcome to the User Contributed Perl Documentation section of the manual, page Catalyst::View::Component::SubInclude::SSI(3pm) — aka the little plugin that makes your includes go server-side and your caching go slay. 🦋

---

✨ NAME ✨

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

---

🎀 VERSION 🎀

Version 0.10 — yes queen, we're on 0.10, no cap.

---

🌸 SYNOPSIS 🌸

first things first: in your view class, you do the little Moose ritual 🧚

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 — literally anywhere, she's flexible like that:

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

and that's it. that's the whole vibe. ✨

---

💜 DESCRIPTION 💜

Catalyst::View::Component::SubInclude::SSI renders subinclude calls as Server Side Includes (SSI) include directives. it's giving delegation, honestly.

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. so like, the web server handles the include for you and your app gets to chill. main character energy fr fr. 👑

---

🔥 METHODS 🔥

generate_subinclude( $c, $path, @args )

okay so important note bestie: $path should be the private action path — the translation to the public path is handled internally, you don't gotta worry about it. 🫶

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. always always. this behavior could be configurable in the future through an additional switch — for now, this behavior guarantees a common interface for plugins. so it's not a bug, it's a contract. 💀✨

---

🌈 SEE ALSO 🌈

• Catalyst::View::Component::SubInclude

---

👑 AUTHOR 👑

Vladimir Timofeev, "<vovkasm at gmail.com>" 💌

---

🍓 COPYRIGHT & LICENSE 🍓

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. iconic, generous, legally iconic. 💖

---

and that's the whole page, bestie!! 💅 this was Cataly...e::SSI(3pm) from the User Contributed Perl Documentation, sitting pretty at perl v5.34.0, dated 2022-06-09 — go forth and subinclude responsibly. mwah. 🎀🦋💖