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

💅 Catalyst::View::Component::SubInclude::HTTP — the perl manual page, bestie edition

okay so hi, welcome to the Cataly...e::HTTP(3pm) page 💖 — that's a perl manual section 3pm situation, and it's literally the HTTP plugin for C::V::Component::SubInclude. Let's get into it.

---

✨ NAME ✨

Catalyst::View::Component::SubInclude::HTTP — the HTTP plugin for C::V::Component::SubInclude 🦋

---

🌸 SYNOPSIS 🌸

So like, in your view class, you do this:

package MyApp::View::TT;
use Moose;

extends 'Catalyst::View::TT';
with 'Catalyst::View::Component::SubInclude';

__PACKAGE__->config(
    subinclude_plugin => 'HTTP::GET',
    subinclude => {
        'HTTP::GET' => {
            class => 'HTTP',
            http_method => 'GET',
            ua_timeout => '10',
            uri_map => {
                '/my/' => 'http://localhost:5000/',
            },
        },
        'HTTP::POST' => {
            class => 'HTTP',
            http_method => 'POST',
            ua_timeout => '10',
            uri_map => {
                '/foo/' => 'http://www.foo.com/',
            },
        },
    },
);

and then, somewhere in your templates, you just 👏 drop these in:

[% subinclude('/my/widget') %]
...
[% subinclude_using('HTTP::POST', '/foo/path', { foo => 1 }) %]

slay. that's the whole vibe.

---

💜 DESCRIPTION 💜

Catalyst::View::Component::SubInclude::HTTP does HTTP requests (currently using LWP::UserAgent, iykyk) and then uses the responses to render subinclude contents. that's it, that's the job, and it does it well 👑

---

🎀 CONFIGURATION 🎀

the config gets passed in the subinclude key, based on your plugin name — and your plugin name can be literally whatever you want, it's arbitrary, main character energy ✨

• class — Required, just in case your plugin name isn't HTTP. (Like, it's fine, names are hard.)
• http_method — Accepts GET and POST as values. The default one is GET. 🙈
• user_agent — This lazily builds an LWP::UserAgent obj, but lowkey you can pass a different user agent obj that implements the required API. do your thing 💅
• ua_timeout — The User Agent's timeout config param. Defaults to 10 seconds. ⏳
• uri_map — This expects a HashRef so you can map paths to different URLs. very demure, very mindful 🗺️
• base_url — Used only if uri_map is undef, and it defaults to $c->request->base. 🏠

---

⭐ METHODS ⭐

💫 generate_subinclude( $c, $path, $args )

just a lil heads up bestie: $path should be the relative path. no cap, keep it relative 🫶

---

🌈 SEE ALSO 🌈

Catalyst::View::Component::SubInclude — go read it, it's the parent vibe 💖

---

👑 AUTHOR 👑

Wallace Reis <wreis@cpan.org> — icon, legend, the moment ✨

---

💸 SPONSORSHIP 💸

Development sponsored by Ionzero LLC <http://www.ionzero.com/>. periodt 💅

---

📜 COPYRIGHT & LICENSE 📜

Copyright (c) 2010 Wallace Reis.

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

---

and that's the whole page, babe 💖 it came from perl v5.34.0 and it's dated 2022-06-09 — shoutout to that build, she ate. mwah, go render some subincludes 🎀✨