Cataly...::Index(3pm)

💖 Catalyst::DispatchType::Index 💖

okay bestie, so this page is Catalyst::DispatchType::Index, part of the Catalyst family of Perl docs (the User Contributed Perl Documentation corner of the manual, iykyk) ✨

---

NAME 🎀

Catalyst::DispatchType::Index — the Index DispatchType. that's it, that's the name, she's serving exactly what it says on the tin 💅

---

SYNOPSIS ✨

not me having zero synopsis of my own — go look at the main character:

See Catalyst::DispatchType.

---

DESCRIPTION 🦋

so this DispatchType is the one handling all the behaviour for index pages. she's the vibe manager for your / route, basically 👑

and if you're new to dispatch types as a whole and wanna know how they work, the lore lives here:

• Catalyst::Manual::Intro — read this one if you're an application author and you wanna know how dispatch types actually affect you and your app 🫶
• Catalyst::DispatchType — read this one for the implementation tea, like how it all works under the hood 🔧

---

METHODS 🌸

$self->match( $c, $path )

she checks whether there's an index action for a given path, and if there is, she sets it up to use that action. super chill. but here's the catch bestie:

it only matches a full URI. and if $c->req->args is already set, this DispatchType is guaranteed not to match. no cap, zero chance, it's not happening 💀

$self->register( $c, $action )

registers an action with this DispatchType. that's the whole job. she clocks in, she registers, she leaves ✨

$self->uri_for_action( $action, $captures )

grabs a URI part for an action. but the way that $captures ruins everything 😭 — if $captures is set, this one always returns undef, because index actions simply don't have captures. no captures, no URI part, periodt 💅

---

AUTHORS 🫶

Catalyst Contributors, see Catalyst.pm — it takes a village, and the village is iconic 👑

---

COPYRIGHT 🎀

This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself. free as in freedom, slay 🌈

---

and that's the whole page bestie!! this lil beauty came from perl v5.40.0, dated 2024-11-15, and it lives in the User Contributed Perl Documentation section of the manual 💖 go forth and dispatch your index pages, mwah 🧚‍♀️⭐