.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 turned on, 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 .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Mason::Manual::RequestDispatch 3pm" .TH Mason::Manual::RequestDispatch 3pm "2014-02-01" "perl v5.18.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" Mason::Manual::RequestDispatch \- How request paths get mapped to page components .SH "DESCRIPTION" .IX Header "DESCRIPTION" Given the request path .PP .Vb 1 \& /news/sports/hockey .Ve .PP Mason searches for the following components in order, setting \f(CW$m\fR\->path_info as noted. .PP .Vb 8 \& /news/sports/hockey.{mp,mc} \& /news/sports/hockey/index.{mp,mc} \& /news/sports/hockey/dhandler.{mp,mc} \& /news/sports/dhandler.{mp,mc} # $m\->path_info = hockey \& /news/sports.{mp,mc} # $m\->path_info = hockey (but see next section) \& /news/dhandler.{mp,mc} # $m\->path_info = sports/hockey \& /news.{mp,mc} # $m\->path_info = sports/hockey (but see next section) \& /dhandler.{mp,mc} # $m\->path_info = news/sports/hockey .Ve .PP where \f(CW\*(C`.{mp,mc}\*(C'\fR means either \f(CW\*(C`.mp\*(C'\fR (indicating a \fIpure-perl\fR component). or \f(CW\*(C`.mc\*(C'\fR (indicating a \fItop-level\fR component). .PP The following sections describe these elements in more detail. .SS "Autoextended path" .IX Subsection "Autoextended path" The request path is suffixed with \*(L".mp\*(R" and \*(L".mc\*(R" to translate it to a component path. .PP .Vb 1 \& /news/sports/hockey.{mp,mc} .Ve .SS "Index" .IX Subsection "Index" An index matches its exact directory, nothing underneath. .PP .Vb 1 \& /news/sports/hockey/index.{mp,mc} .Ve .SS "Dhandlers" .IX Subsection "Dhandlers" A dhandler matches its directory as well as anything underneath, setting \f(CW\*(C`$m\->path_info\*(C'\fR to the remainder. .PP .Vb 4 \& /news/sports/hockey/dhandler.{mp,mc} \& /news/sports/dhandler.{mp,mc} # $m\->path_info = hockey \& /news/dhandler.{mp,mc} # $m\->path_info = sports/hockey \& /dhandler.{mp,mc} # $m\->path_info = news/sports/hockey .Ve .SS "Partial paths" .IX Subsection "Partial paths" A component can match an initial part of the \s-1URL,\s0 setting \f(CW\*(C`$m\->path_info\*(C'\fR to the remainder: .PP .Vb 2 \& /news/sports.{mp,mc} # $m\->path_info = hockey \& /news.{mp,mc} # $m\->path_info = sports/hockey .Ve .PP Since this isn't always desirable behavior, it must be explicitly enabled for the component. Mason will call method \f(CW\*(C`allow_path_info\*(C'\fR on the component class, and will only allow the match if it returns true: .PP .Vb 3 \& <%class> \& method allow_path_info { 1 } \& .Ve .PP The default \f(CW\*(C`allow_path_info\*(C'\fR returns false. .PP \&\f(CW\*(C`allow_path_info\*(C'\fR is not checked on dhandlers, since the whole point of dhandlers is to match partial paths. .SS "Trailing slash" .IX Subsection "Trailing slash" If the request \s-1URL\s0 has a trailing slash (ends with \f(CW\*(C`/\*(C'\fR), we remove it before the match process begins and add it to the \f(CW\*(C`$m\->path_info\*(C'\fR. Components that should match must have \f(CW\*(C`allow_path_info\*(C'\fR return true. .PP For example: .PP .Vb 6 \& ## request URL /news/ \& /news/index.{mp,mc} # $m\->path_info = / if index.{mp,mc} has \& # allow_path_info => true \& /news/dhandler.{mp,mc} # $m\->path_info = / \& /news.{mp,mc} # $m\->path_info = / if news.{mp,mc} has \& # allow_path_info => true \& \& ## request URL /news/sports/ \& /news/sports/index.{mp,mc} # $m\->path_info = / if index.{mp,mc} has \& # allow_path_info => true \& /news/sports/dhandler.{mp,mc} # $m\->path_info = / \& /news/sports.{mp,mc} # $m\->path_info = / if sports.{mp,mc} \& # has allow_path_info => true \& /news/dhandler.{mp,mc} # $m\->path_info = sports/ \& /news.{mp,mc} # $m\->path_info = /sports/ if news.{mp,mc} \& # has allow_path_info => true .Ve .SS "Routes" .IX Subsection "Routes" It is possible to use route syntax to more elegantly parse \f(CW\*(C`$m\->path_info\*(C'\fR for dhandlers and partial paths, e.g. .PP .Vb 3 \& <%class> \& route "{year:[0\-9]+}/{month:[0\-9]{2}}"; \& .Ve .PP See Mason::Plugin::RouterSimple. .SH "SEE ALSO" .IX Header "SEE ALSO" Mason .SH "AUTHOR" .IX Header "AUTHOR" Jonathan Swartz .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2012 by Jonathan Swartz. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.