REST::...:Routes(3pm)

REST::...:Routes(3pm) 💖

okay bestie, welcome to the User Contributed Perl Documentation for REST::...:Routes(3pm) — yes that's the actual manual name, it's giving dramatic ellipsis energy and we're obsessed 💅

---

✨ NAME ✨

REST::Application::Routes — a whole implementation of Ruby on Rails type routes. no cap, that's literally what it is 🦋

---

🎀 SYNOPSIS 🎀

package MyApp;
use base 'REST::Application::Routes';

my $obj = REST::Application::Routes->new();
$obj->loadResource(
    '/data/workspaces/:ws/pages/:page', => \&do_thing,
    # ... other routes here ...
);

sub do_thing {
    my %vars = @_;
    print $vars{ws} . " " . $vars{page} . "\n";
}

# Now, in some other place.  Maybe a CGI file or an Apache handler, do:
use MyApp;
MyApp->new->run("/data/workspaces/cows/pages/good"); # prints "cows good"

like. look at that. <lavender>"cows good"</lavender> just printing itself into existence. main character behaviour fr fr 🐄✨

---

🌸 DESCRIPTION 🌸

so Ruby on Rails has this concept of routes, right? and routes are URI path info templates that are tied to specific code — like Controllers and Actions in Rails, iykyk. so basically routes consist of key value pairs, called the route map, where the key is the path info template and the value is a code reference. periodt. 💅

a template is of the form <lavender>"/foo/:variable/bar"</lavender> where variables are always prefaced with a colon. when a given path gets passed to run(), the code reference which the template maps to will be passed a hash where the keys are the variable names (sans colon, obviously) and the values are what was specified in place of the variables. it's giving fill-in-the-blank but make it ✨infrastructure✨

the route map is ordered, so the most specific matching template is used — which means you should order your templates from least generic to most generic. do NOT skip this step bestie, order matters 😭

see REST::Application for details. the only difference between this module and that one is that this one uses URI templates as keys in the resourceHooks rather than regexes. tiny glow-up, huge difference 💖

---

👑 METHODS 👑

these are methods which REST::Application::Routes has but its superclass does not. exclusive. VIP. no gatekeeping 🫶

getTemplateVars()

returns a hash whose keys are the :symbols from the URI template and whose values are what where matched to be there. 🦋

it is assumed that this method is called either from within or after loadResource() is called. otherwise you're likely to get an empty hash back. not a vibe. tragic even. 💀

getLastMatchTemplate()

this is an alias for getLastMatchPattern(), since this class is about templates rather than regexes. same energy, cuter name, we love a rebrand 🌈

---

💜 AUTHORS 💜

Matthew O'Connor <matthew@canonical.org> — king behaviour, credit where credit is due 👑

---

⭐ LICENSE ⭐

this program is free software. it is subject to the same license as Perl itself. free as in freedom bestie, go wild (responsibly) 🎀

---

🔥 SEE ALSO 🔥

• REST::Application
• <http://manuals.rubyonrails.com/read/chapter/65>

---

and that's the whole page babes!! this was perl v5.30.3, dated 2020-07-23, filed under REST::...:Routes(3pm) — go forth and route your little heart out, ily, mwah 💖💅✨