local-lib5/man/man3/Catalyst::Utils.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::Utils 3"
 132 .TH Catalyst::Utils 3 "2009-11-30" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Catalyst::Utils \- The Catalyst Utils
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 See Catalyst.
 138 .SH "DESCRIPTION"
 139 .IX Header "DESCRIPTION"
 140 Catalyst Utilities.
 141 .SH "METHODS"
 142 .IX Header "METHODS"
 143 .Sh "appprefix($class)"
 144 .IX Subsection "appprefix($class)"
 145 .Vb 1
 146 \&    MyApp::Foo becomes myapp_foo
 147 .Ve
 148 .Sh "class2appclass($class);"
 149 .IX Subsection "class2appclass($class);"
 150 .Vb 2
 151 \&    MyApp::Controller::Foo::Bar becomes MyApp
 152 \&    My::App::Controller::Foo::Bar becomes My::App
 153 .Ve
 154 .Sh "class2classprefix($class);"
 155 .IX Subsection "class2classprefix($class);"
 156 .Vb 2
 157 \&    MyApp::Controller::Foo::Bar becomes MyApp::Controller
 158 \&    My::App::Controller::Foo::Bar becomes My::App::Controller
 159 .Ve
 160 .Sh "class2classsuffix($class);"
 161 .IX Subsection "class2classsuffix($class);"
 162 .Vb 1
 163 \&    MyApp::Controller::Foo::Bar becomes Controller::Foo::Bar
 164 .Ve
 165 .Sh "class2env($class);"
 166 .IX Subsection "class2env($class);"
 167 Returns the environment name for class.
 168 .PP
 169 .Vb 2
 170 \&    MyApp becomes MYAPP
 171 \&    My::App becomes MY_APP
 172 .Ve
 173 .ie n .Sh "class2prefix( $class\fP, \f(CW$case );"
 174 .el .Sh "class2prefix( \f(CW$class\fP, \f(CW$case\fP );"
 175 .IX Subsection "class2prefix( $class, $case );"
 176 Returns the uri prefix for a class. If case is false the prefix is converted to lowercase.
 177 .PP
 178 .Vb 1
 179 \&    My::App::Controller::Foo::Bar becomes foo/bar
 180 .Ve
 181 .ie n .Sh "class2tempdir( $class\fP [, \f(CW$create ] );"
 182 .el .Sh "class2tempdir( \f(CW$class\fP [, \f(CW$create\fP ] );"
 183 .IX Subsection "class2tempdir( $class [, $create ] );"
 184 Returns a tempdir for a class. If create is true it will try to create the path.
 185 .PP
 186 .Vb 2
 187 \&    My::App becomes /tmp/my/app
 188 \&    My::App::Controller::Foo::Bar becomes /tmp/my/app/c/foo/bar
 189 .Ve
 190 .Sh "home($class)"
 191 .IX Subsection "home($class)"
 192 Returns home directory for given class.
 193 .ie n .Sh "prefix($class, $name);"
 194 .el .Sh "prefix($class, \f(CW$name\fP);"
 195 .IX Subsection "prefix($class, $name);"
 196 Returns a prefixed action.
 197 .PP
 198 .Vb 1
 199 \&    MyApp::Controller::Foo::Bar, yada becomes foo/bar/yada
 200 .Ve
 201 .Sh "request($uri)"
 202 .IX Subsection "request($uri)"
 203 Returns an HTTP::Request object for a uri.
 204 .Sh "ensure_class_loaded($class_name, \e%opts)"
 205 .IX Subsection "ensure_class_loaded($class_name, %opts)"
 206 Loads the class unless it already has been loaded.
 207 .PP
 208 If \f(CW$opts\fR{ignore_loaded} is true always tries the require whether the package
 209 already exists or not. Only pass this if you're either (a) sure you know the
 210 file exists on disk or (b) have code to catch the file not found exception
 211 that will result if it doesn't.
 212 .ie n .Sh "merge_hashes($hashref, $hashref)"
 213 .el .Sh "merge_hashes($hashref, \f(CW$hashref\fP)"
 214 .IX Subsection "merge_hashes($hashref, $hashref)"
 215 Base code to recursively merge two hashes together with right-hand precedence.
 216 .ie n .Sh "env_value($class, $key)"
 217 .el .Sh "env_value($class, \f(CW$key\fP)"
 218 .IX Subsection "env_value($class, $key)"
 219 Checks for and returns an environment value. For instance, if \f(CW$key\fR is
 220 \&'home', then this method will check for and return the first value it finds,
 221 looking at \f(CW$ENV\fR{\s-1MYAPP_HOME\s0} and \f(CW$ENV\fR{\s-1CATALYST_HOME\s0}.
 222 .Sh "term_width"
 223 .IX Subsection "term_width"
 224 Try to guess terminal width to use with formatting of debug output
 225 .PP
 226 All you need to get this work, is:
 227 .PP
 228 1) Install Term::Size::Any, or
 229 .PP
 230 2) Export \f(CW$COLUMNS\fR from your shell.
 231 .PP
 232 (Warning to bash users: 'echo \f(CW$COLUMNS\fR' may be showing you the bash
 233 variable, not \f(CW$ENV\fR{\s-1COLUMNS\s0}. 'export COLUMNS=$COLUMNS' and you should see
 234 that 'env' now lists \s-1COLUMNS\s0.)
 235 .PP
 236 As last resort, default value of 80 chars will be used.
 237 .Sh "resolve_namespace"
 238 .IX Subsection "resolve_namespace"
 239 Method which adds the namespace for plugins and actions.
 240 .PP
 241 .Vb 1
 242 \&  __PACKAGE__\->setup(qw(MyPlugin));
 243 .Ve
 244 .PP
 245 .Vb 1
 246 \&  # will load Catalyst::Plugin::MyPlugin
 247 .Ve
 248 .SH "AUTHORS"
 249 .IX Header "AUTHORS"
 250 Catalyst Contributors, see Catalyst.pm
 251 .SH "COPYRIGHT"
 252 .IX Header "COPYRIGHT"
 253 This library is free software. You can redistribute it and/or modify it under
 254 the same terms as Perl itself.