local-lib5/man/man3/Catalyst::DispatchType::Regex.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "Catalyst::DispatchType::Regex 3"
 132 .TH Catalyst::DispatchType::Regex 3 "2009-09-02" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Catalyst::DispatchType::Regex \- Regex DispatchType
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 See Catalyst::DispatchType.
 138 .SH "DESCRIPTION"
 139 .IX Header "DESCRIPTION"
 140 Dispatch type managing path-matching behaviour using regexes.  For
 141 more information on dispatch types, see:
 142 .IP "* Catalyst::Manual::Intro for how they affect application authors" 4
 143 .IX Item "Catalyst::Manual::Intro for how they affect application authors"
 144 .PD 0
 145 .IP "* Catalyst::DispatchType for implementation information." 4
 146 .IX Item "Catalyst::DispatchType for implementation information."
 147 .PD
 148 .SH "METHODS"
 149 .IX Header "METHODS"
 150 .Sh "$self\->list($c)"
 151 .IX Subsection "$self->list($c)"
 152 Output a table of all regex actions, and their private equivalent.
 153 .ie n .Sh "$self\->match( $c\fP, \f(CW$path )"
 154 .el .Sh "$self\->match( \f(CW$c\fP, \f(CW$path\fP )"
 155 .IX Subsection "$self->match( $c, $path )"
 156 Checks path against every compiled regex, and offers the action for any regex
 157 which matches a chance to match the request. If it succeeds, sets action,
 158 match and captures on \f(CW$c\fR\->req and returns 1. If not, returns 0 without
 159 altering \f(CW$c\fR.
 160 .ie n .Sh "$self\->register( $c\fP, \f(CW$action )"
 161 .el .Sh "$self\->register( \f(CW$c\fP, \f(CW$action\fP )"
 162 .IX Subsection "$self->register( $c, $action )"
 163 Registers one or more regex actions for an action object.
 164 Also registers them as literal paths.
 165 .PP
 166 Returns 1 if any regexps were registered.
 167 .ie n .Sh "$self\->register_regex($c, $re\fP, \f(CW$action)"
 168 .el .Sh "$self\->register_regex($c, \f(CW$re\fP, \f(CW$action\fP)"
 169 .IX Subsection "$self->register_regex($c, $re, $action)"
 170 Register an individual regex on the action. Usually called from the
 171 register method.
 172 .ie n .Sh "$self\->uri_for_action($action, $captures)"
 173 .el .Sh "$self\->uri_for_action($action, \f(CW$captures\fP)"
 174 .IX Subsection "$self->uri_for_action($action, $captures)"
 175 returns a \s-1URI\s0 for this action if it can find a regex attributes that contains
 176 the correct number of () captures. Note that this may function incorrectly
 177 in the case of nested captures \- if your regex does (...(..))..(..) you'll
 178 need to pass the first and third captures only.
 179 .SH "AUTHORS"
 180 .IX Header "AUTHORS"
 181 Catalyst Contributors, see Catalyst.pm
 182 .SH "COPYRIGHT"
 183 .IX Header "COPYRIGHT"
 184 This library is free software. You can redistribute it and/or modify it under
 185 the same terms as Perl itself.