.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Mojolicious::Routes 3pm"
.TH Mojolicious::Routes 3pm 2024-05-15 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Mojolicious::Routes \- Always find your destination with routes
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Mojolicious::Routes;
\&
\&  # Simple route
\&  my $r = Mojolicious::Routes\->new;
\&  $r\->any(\*(Aq/\*(Aq)\->to(controller => \*(Aqblog\*(Aq, action => \*(Aqwelcome\*(Aq);
\&
\&  # More advanced routes
\&  my $blog = $r\->under(\*(Aq/blog\*(Aq);
\&  $blog\->get(\*(Aq/list\*(Aq)\->to(\*(Aqblog#list\*(Aq);
\&  $blog\->get(\*(Aq/:id\*(Aq => [id => qr/\ed+/])\->to(\*(Aqblog#show\*(Aq, id => 23);
\&  $blog\->patch(sub ($c) { $c\->render(text => \*(AqGo away!\*(Aq, status => 405) });
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Mojolicious::Routes is the core of the Mojolicious web framework.
.PP
See Mojolicious::Guides::Routing for more.
.SH TYPES
.IX Header "TYPES"
These placeholder types are available by default.
.SS num
.IX Subsection "num"
.Vb 1
\&  $r\->get(\*(Aq/article/<id:num>\*(Aq);
.Ve
.PP
Placeholder value needs to be a non-fractional number, similar to the regular expression \f(CW\*(C`([0\-9]+)\*(C'\fR.
.SH ATTRIBUTES
.IX Header "ATTRIBUTES"
Mojolicious::Routes inherits all attributes from Mojolicious::Routes::Route and implements the following new
ones.
.SS base_classes
.IX Subsection "base_classes"
.Vb 2
\&  my $classes = $r\->base_classes;
\&  $r          = $r\->base_classes([\*(AqMyApp::Controller\*(Aq]);
.Ve
.PP
Base classes used to identify controllers, defaults to Mojolicious::Controller and Mojolicious.
.SS cache
.IX Subsection "cache"
.Vb 2
\&  my $cache = $r\->cache;
\&  $r        = $r\->cache(Mojo::Cache\->new);
.Ve
.PP
Routing cache, defaults to a Mojo::Cache object.
.SS conditions
.IX Subsection "conditions"
.Vb 2
\&  my $conditions = $r\->conditions;
\&  $r             = $r\->conditions({foo => sub {...}});
.Ve
.PP
Contains all available conditions.
.SS namespaces
.IX Subsection "namespaces"
.Vb 2
\&  my $namespaces = $r\->namespaces;
\&  $r             = $r\->namespaces([\*(AqMyApp::Controller\*(Aq, \*(AqMyApp\*(Aq]);
.Ve
.PP
Namespaces to load controllers from.
.PP
.Vb 2
\&  # Add another namespace to load controllers from
\&  push @{$r\->namespaces}, \*(AqMyApp::MyController\*(Aq;
.Ve
.SS shortcuts
.IX Subsection "shortcuts"
.Vb 2
\&  my $shortcuts = $r\->shortcuts;
\&  $r            = $r\->shortcuts({foo => sub {...}});
.Ve
.PP
Contains all available shortcuts.
.SS types
.IX Subsection "types"
.Vb 2
\&  my $types = $r\->types;
\&  $r        = $r\->types({lower => qr/[a\-z]+/});
.Ve
.PP
Registered placeholder types, by default only "num" is already defined.
.SH METHODS
.IX Header "METHODS"
Mojolicious::Routes inherits all methods from Mojolicious::Routes::Route and implements the following new ones.
.SS add_condition
.IX Subsection "add_condition"
.Vb 1
\&  $r = $r\->add_condition(foo => sub ($route, $c, $captures, $arg) {...});
.Ve
.PP
Register a condition.
.PP
.Vb 4
\&  $r\->add_condition(foo => sub ($route, $c, $captures, $arg) {
\&    ...
\&    return 1;
\&  });
.Ve
.SS add_shortcut
.IX Subsection "add_shortcut"
.Vb 1
\&  $r = $r\->add_shortcut(foo => sub ($route, @args) {...});
.Ve
.PP
Register a shortcut.
.PP
.Vb 1
\&  $r\->add_shortcut(foo => sub ($route, @args) {...});
.Ve
.SS add_type
.IX Subsection "add_type"
.Vb 2
\&  $r = $r\->add_type(foo => qr/\ew+/);
\&  $r = $r\->add_type(foo => [\*(Aqbar\*(Aq, \*(Aqbaz\*(Aq]);
.Ve
.PP
Register a placeholder type.
.PP
.Vb 1
\&  $r\->add_type(lower => qr/[a\-z]+/);
.Ve
.SS continue
.IX Subsection "continue"
.Vb 1
\&  $r\->continue(Mojolicious::Controller\->new);
.Ve
.PP
Continue dispatch chain and emit the hook "around_action" in Mojolicious for every action.
.SS dispatch
.IX Subsection "dispatch"
.Vb 1
\&  my $bool = $r\->dispatch(Mojolicious::Controller\->new);
.Ve
.PP
Match routes with "match" and dispatch with "continue".
.SS lookup
.IX Subsection "lookup"
.Vb 1
\&  my $route = $r\->lookup(\*(Aqfoo\*(Aq);
.Ve
.PP
Find route by name with "find" in Mojolicious::Routes::Route and cache all results for future lookups.
.SS match
.IX Subsection "match"
.Vb 1
\&  $r\->match(Mojolicious::Controller\->new);
.Ve
.PP
Match routes with Mojolicious::Routes::Match.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mojolicious, Mojolicious::Guides, <https://mojolicious.org>.