local-lib5/man/man3/Catalyst::Action.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::Action 3"
 132 .TH Catalyst::Action 3 "2009-09-02" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Catalyst::Action \- Catalyst Action
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 1
 138 \&    <form action="[%c.uri_for(c.action)%]">
 139 .Ve
 140 .PP
 141 .Vb 1
 142 \&    $c\->forward( $action\->private_path );
 143 .Ve
 144 .SH "DESCRIPTION"
 145 .IX Header "DESCRIPTION"
 146 This class represents a Catalyst Action. You can access the object for the
 147 currently dispatched action via \f(CW$c\fR\->action. See the Catalyst::Dispatcher
 148 for more information on how actions are dispatched. Actions are defined in
 149 Catalyst::Controller subclasses.
 150 .SH "METHODS"
 151 .IX Header "METHODS"
 152 .Sh "attributes"
 153 .IX Subsection "attributes"
 154 The sub attributes that are set for this action, like Local, Path, Private
 155 and so on. This determines how the action is dispatched to.
 156 .Sh "class"
 157 .IX Subsection "class"
 158 Returns the name of the component where this action is defined.
 159 Derived by calling the Catalyst::Component/catalyst_component_name
 160 method on each component.
 161 .Sh "code"
 162 .IX Subsection "code"
 163 Returns a code reference to this action.
 164 .ie n .Sh "dispatch( $c )"
 165 .el .Sh "dispatch( \f(CW$c\fP )"
 166 .IX Subsection "dispatch( $c )"
 167 Dispatch this action against a context.
 168 .ie n .Sh "execute( $controller\fP, \f(CW$c\fP, \f(CW@args )"
 169 .el .Sh "execute( \f(CW$controller\fP, \f(CW$c\fP, \f(CW@args\fP )"
 170 .IX Subsection "execute( $controller, $c, @args )"
 171 Execute this action's coderef against a given controller with a given
 172 context and arguments
 173 .ie n .Sh "match( $c )"
 174 .el .Sh "match( \f(CW$c\fP )"
 175 .IX Subsection "match( $c )"
 176 Check Args attribute, and makes sure number of args matches the setting.
 177 Always returns true if Args is omitted.
 178 .Sh "compare"
 179 .IX Subsection "compare"
 180 Compares 2 actions based on the value of the \f(CW\*(C`Args\*(C'\fR attribute, with no \f(CW\*(C`Args\*(C'\fR
 181 having the highest precedence.
 182 .Sh "namespace"
 183 .IX Subsection "namespace"
 184 Returns the private namespace this action lives in.
 185 .Sh "reverse"
 186 .IX Subsection "reverse"
 187 Returns the private path for this action.
 188 .Sh "private_path"
 189 .IX Subsection "private_path"
 190 Returns absolute private path for this action. Unlike \f(CW\*(C`reverse\*(C'\fR, the
 191 \&\f(CW\*(C`private_path\*(C'\fR of an action is always suitable for passing to \f(CW\*(C`forward\*(C'\fR.
 192 .Sh "name"
 193 .IX Subsection "name"
 194 Returns the sub name of this action.
 195 .Sh "meta"
 196 .IX Subsection "meta"
 197 Provided by Moose.
 198 .SH "AUTHORS"
 199 .IX Header "AUTHORS"
 200 Catalyst Contributors, see Catalyst.pm
 201 .SH "COPYRIGHT"
 202 .IX Header "COPYRIGHT"
 203 This library is free software. You can redistribute it and/or modify it under
 204 the same terms as Perl itself.