local-lib5/man/man3/Catalyst::Controller::ActionRole.3pm

   1 .\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "Catalyst::Controller::ActionRole 3"
 127 .TH Catalyst::Controller::ActionRole 3 "2010-05-02" "perl v5.8.8" "User Contributed Perl Documentation"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 Catalyst::Controller::ActionRole \- Apply roles to action instances
 134 .SH "VERSION"
 135 .IX Header "VERSION"
 136 version 0.14
 137 .SH "SYNOPSIS"
 138 .IX Header "SYNOPSIS"
 139 .Vb 1
 140 \&    package MyApp::Controller::Foo;
 141 \&
 142 \&    use parent qw/Catalyst::Controller::ActionRole/;
 143 \&
 144 \&    sub bar : Local Does(\*(AqMoo\*(Aq) { ... }
 145 .Ve
 146 .SH "DESCRIPTION"
 147 .IX Header "DESCRIPTION"
 148 This module allows to apply roles to the \f(CW\*(C`Catalyst::Action\*(C'\fRs for different
 149 controller methods.
 150 .PP
 151 For that a \f(CW\*(C`Does\*(C'\fR attribute is provided. That attribute takes an argument,
 152 that determines the role, which is going to be applied. If that argument is
 153 prefixed with \f(CW\*(C`+\*(C'\fR, it is assumed to be the full name of the role. If it's
 154 prefixed with \f(CW\*(C`~\*(C'\fR, the name of your application followed by
 155 \&\f(CW\*(C`::ActionRole::\*(C'\fR is prepended. If it isn't prefixed with \f(CW\*(C`+\*(C'\fR or \f(CW\*(C`~\*(C'\fR,
 156 the role name will be searched for in \f(CW@INC\fR according to the rules for
 157 role prefix searching.
 158 .PP
 159 Additionally it's possible to to apply roles to \fBall\fR actions of a controller
 160 without specifying the \f(CW\*(C`Does\*(C'\fR keyword in every action definition:
 161 .PP
 162 .Vb 1
 163 \&    package MyApp::Controller::Bar
 164 \&
 165 \&    use parent qw/Catalyst::Controller::ActionRole/;
 166 \&
 167 \&    _\|_PACKAGE_\|_\->config(
 168 \&        action_roles => [\*(AqFoo\*(Aq, \*(Aq~Bar\*(Aq],
 169 \&    );
 170 \&
 171 \&    # has Catalyst::ActionRole::Foo and MyApp::ActionRole::Bar applied
 172 \&    # if MyApp::ActionRole::Foo exists and is loadable, it will take
 173 \&    # precedence over Catalyst::ActionRole::Foo
 174 \&    sub moo : Local { ... }
 175 .Ve
 176 .SH "ATTRIBUTES"
 177 .IX Header "ATTRIBUTES"
 178 .SS "_action_role_prefix"
 179 .IX Subsection "_action_role_prefix"
 180 This class attribute stores an array reference of role prefixes to search for
 181 role names in if they aren't prefixed with \f(CW\*(C`+\*(C'\fR or \f(CW\*(C`~\*(C'\fR. It defaults to
 182 \&\f(CW\*(C`[ \*(AqCatalyst::ActionRole::\*(Aq ]\*(C'\fR.  See \*(L"role prefix searching\*(R".
 183 .SS "_action_roles"
 184 .IX Subsection "_action_roles"
 185 This attribute stores an array reference of role names that will be applied to
 186 every action of this controller. It can be set by passing a \f(CW\*(C`action_roles\*(C'\fR
 187 argument to the constructor. The same expansions as for \f(CW\*(C`Does\*(C'\fR will be
 188 performed.
 189 .SH "ROLE PREFIX SEARCHING"
 190 .IX Header "ROLE PREFIX SEARCHING"
 191 Roles specified with no prefix are looked up under a set of role prefixes.  The
 192 first prefix is always \f(CW\*(C`MyApp::ActionRole::\*(C'\fR (with \f(CW\*(C`MyApp\*(C'\fR replaced as
 193 appropriate for your application); the following prefixes are taken from the
 194 \&\f(CW\*(C`_action_role_prefix\*(C'\fR attribute.
 195 .SH "AUTHORS"
 196 .IX Header "AUTHORS"
 197 .Vb 2
 198 \&  Florian Ragwitz <rafl@debian.org>
 199 \&  Hans Dieter Pearcey <hdp@weftsoar.net>
 200 .Ve
 201 .SH "COPYRIGHT AND LICENSE"
 202 .IX Header "COPYRIGHT AND LICENSE"
 203 This software is copyright (c) 2010 by Florian Ragwitz.
 204 .PP
 205 This is free software; you can redistribute it and/or modify it under
 206 the same terms as the Perl 5 programming language system itself.