local-lib5/man/man3/Moose::Cookbook::Meta::Recipe5.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 "Moose::Cookbook::Meta::Recipe5 3"
 132 .TH Moose::Cookbook::Meta::Recipe5 3 "2009-03-14" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Moose::Cookbook::Meta::Recipe5 \- The "table" attribute as a metaclass trait
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 2
 138 \&  package MyApp::Meta::Class::Trait::HasTable;
 139 \&  use Moose::Role;
 140 .Ve
 141 .PP
 142 .Vb 4
 143 \&  has table => (
 144 \&      is  => 'rw',
 145 \&      isa => 'Str',
 146 \&  );
 147 .Ve
 148 .PP
 149 .Vb 2
 150 \&  package Moose::Meta::Class::Custom::Trait::HasTable;
 151 \&  sub register_implementation { 'MyApp::Meta::Class::Trait::HasTable' }
 152 .Ve
 153 .PP
 154 .Vb 2
 155 \&  package MyApp::User;
 156 \&  use Moose \-traits => 'HasTable';
 157 .Ve
 158 .PP
 159 .Vb 1
 160 \&  __PACKAGE__\->meta\->table('User');
 161 .Ve
 162 .SH "DESCRIPTION"
 163 .IX Header "DESCRIPTION"
 164 This recipe takes the metaclass table attribute from
 165 Moose::Cookbook::Meta::Recipe4 and implements it as a metaclass
 166 trait. Traits are just roles, as we saw in
 167 Moose::Cookbook::Meta::Recipe3.
 168 .PP
 169 The advantage of using traits is that it's easy to combine multiple
 170 traits, whereas combining multiple metaclass subclasses requires
 171 creating yet another subclass. With traits, Moose takes care of
 172 applying them to your metaclass.
 173 .Sh "Using this Metaclass Trait in Practice"
 174 .IX Subsection "Using this Metaclass Trait in Practice"
 175 Once this trait has been applied to a metaclass, it looks exactly like
 176 the example we saw in Moose::Cookbook::Meta::Recipe4:
 177 .PP
 178 .Vb 1
 179 \&  my $table = MyApp::User\->meta\->table;
 180 .Ve
 181 .PP
 182 .Vb 4
 183 \&  # the safe version
 184 \&  $table = MyApp::User\->meta\->table
 185 \&      if MyApp::User\->meta\->meta\->can('does')
 186 \&         and MyApp::User\->meta\->meta\->does('MyApp::Meta::Class');
 187 .Ve
 188 .PP
 189 The safe version is a little complicated. We have to check that the
 190 metaclass object's metaclass has a \f(CW\*(C`does\*(C'\fR method, in which case we
 191 can ask if the the metaclass does a given role.
 192 .PP
 193 It's simpler to just write:
 194 .PP
 195 .Vb 2
 196 \&  $table = MyApp::User\->meta\->table
 197 \&      if MyApp::User\->meta\->can('table');
 198 .Ve
 199 .PP
 200 In theory, this is a little less correct, since the metaclass might be
 201 getting its \f(CW\*(C`table\*(C'\fR method from a \fIdifferent\fR role. In practice, you
 202 are unlikely to encounter this sort of problem.
 203 .SH "SEE ALSO"
 204 .IX Header "SEE ALSO"
 205 Moose::Cookbook::Meta::Recipe3 \- Labels implemented via attribute
 206 traits
 207 .PP
 208 Moose::Cookbook::Meta::Recipe4 \- Adding a \*(L"table\*(R" attribute to the
 209 metaclass
 210 .SH "AUTHOR"
 211 .IX Header "AUTHOR"
 212 Dave Rolsky <autarch@urth.org>
 213 .SH "COPYRIGHT AND LICENSE"
 214 .IX Header "COPYRIGHT AND LICENSE"
 215 Copyright 2006\-2009 by Infinity Interactive, Inc.
 216 .PP
 217 <http://www.iinteractive.com>
 218 .PP
 219 This library is free software; you can redistribute it and/or modify
 220 it under the same terms as Perl itself.