local-lib5/man/man3/Catalyst::Controller.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::Controller 3"
 132 .TH Catalyst::Controller 3 "2009-11-30" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Catalyst::Controller \- Catalyst Controller base class
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 2
 138 \&  package MyApp::Controller::Search
 139 \&  use base qw/Catalyst::Controller/;
 140 .Ve
 141 .PP
 142 .Vb 4
 143 \&  sub foo : Local {
 144 \&    my ($self,$c,@args) = @_;
 145 \&    ...
 146 \&  } # Dispatches to /search/foo
 147 .Ve
 148 .SH "DESCRIPTION"
 149 .IX Header "DESCRIPTION"
 150 Controllers are where the actions in the Catalyst framework
 151 reside. Each action is represented by a function with an attribute to
 152 identify what kind of action it is. See the Catalyst::Dispatcher
 153 for more info about how Catalyst dispatches to actions.
 154 .SH "CONFIGURATION"
 155 .IX Header "CONFIGURATION"
 156 Like any other Catalyst::Component, controllers have a config hash,
 157 accessible through \f(CW$self\fR\->config from the controller actions.  Some
 158 settings are in use by the Catalyst framework:
 159 .Sh "namespace"
 160 .IX Subsection "namespace"
 161 This specifies the internal namespace the controller should be bound
 162 to. By default the controller is bound to the \s-1URI\s0 version of the
 163 controller name. For instance controller 'MyApp::Controller::Foo::Bar'
 164 will be bound to 'foo/bar'. The default Root controller is an example
 165 of setting namespace to '' (the null string).
 166 .Sh "path"
 167 .IX Subsection "path"
 168 Sets 'path_prefix', as described below.
 169 .SH "METHODS"
 170 .IX Header "METHODS"
 171 .ie n .Sh "\s-1BUILDARGS\s0 ($app, @args)"
 172 .el .Sh "\s-1BUILDARGS\s0 ($app, \f(CW@args\fP)"
 173 .IX Subsection "BUILDARGS ($app, @args)"
 174 From Catalyst::Component::ApplicationAttribute, stashes the application
 175 instance as \f(CW$self\fR\->_application.
 176 .Sh "$self\->action_for('name')"
 177 .IX Subsection "$self->action_for('name')"
 178 Returns the Catalyst::Action object (if any) for a given method name
 179 in this component.
 180 .Sh "$self\->action_namespace($c)"
 181 .IX Subsection "$self->action_namespace($c)"
 182 Returns the private namespace for actions in this component. Defaults
 183 to a value from the controller name (for
 184 e.g. MyApp::Controller::Foo::Bar becomes \*(L"foo/bar\*(R") or can be
 185 overridden from the \*(L"namespace\*(R" config key.
 186 .Sh "$self\->path_prefix($c)"
 187 .IX Subsection "$self->path_prefix($c)"
 188 Returns the default path prefix for :PathPrefix, :Local, :LocalRegex and
 189 relative :Path actions in this component. Defaults to the action_namespace or
 190 can be overridden from the \*(L"path\*(R" config key.
 191 .Sh "$self\->register_actions($c)"
 192 .IX Subsection "$self->register_actions($c)"
 193 Finds all applicable actions for this component, creates
 194 Catalyst::Action objects (using \f(CW$self\fR\->create_action) for them and
 195 registers them with \f(CW$c\fR\->dispatcher.
 196 .Sh "$self\->\fIget_action_methods()\fP"
 197 .IX Subsection "$self->get_action_methods()"
 198 Returns a list of Moose::Meta::Method objects, doing the
 199 MooseX::MethodAttributes::Role::Meta::Method role, which are the set of
 200 action methods for this package.
 201 .ie n .Sh "$self\->register_action_methods($c, @methods)"
 202 .el .Sh "$self\->register_action_methods($c, \f(CW@methods\fP)"
 203 .IX Subsection "$self->register_action_methods($c, @methods)"
 204 Creates action objects for a set of action methods using \f(CW\*(C` create_action \*(C'\fR,
 205 and registers them with the dispatcher.
 206 .Sh "$self\->create_action(%args)"
 207 .IX Subsection "$self->create_action(%args)"
 208 Called with a hash of data to be use for construction of a new
 209 Catalyst::Action (or appropriate sub/alternative class) object.
 210 .Sh "$self\->_application"
 211 .IX Subsection "$self->_application"
 212 .Sh "$self\->_app"
 213 .IX Subsection "$self->_app"
 214 Returns the application instance stored by \f(CW\*(C`new()\*(C'\fR
 215 .SH "AUTHORS"
 216 .IX Header "AUTHORS"
 217 Catalyst Contributors, see Catalyst.pm
 218 .SH "COPYRIGHT"
 219 .IX Header "COPYRIGHT"
 220 This library is free software. You can redistribute it and/or modify
 221 it under the same terms as Perl itself.