.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Moose::Cookbook::Meta::Table_MetaclassTrait 3pm"
.TH Moose::Cookbook::Meta::Table_MetaclassTrait 3pm "2014-09-25" "perl v5.20.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Moose::Cookbook::Meta::Table_MetaclassTrait \- Adding a "table" attribute as a metaclass trait
.SH "VERSION"
.IX Header "VERSION"
version 2.1213
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\&  # in lib/MyApp/Meta/Class/Trait/HasTable.pm
\&  package MyApp::Meta::Class::Trait::HasTable;
\&  use Moose::Role;
\&  Moose::Util::meta_class_alias(\*(AqHasTable\*(Aq);
\&
\&  has table => (
\&      is  => \*(Aqrw\*(Aq,
\&      isa => \*(AqStr\*(Aq,
\&  );
\&
\&  # in lib/MyApp/User.pm
\&  package MyApp::User;
\&  use Moose \-traits => \*(AqHasTable\*(Aq;
\&
\&  _\|_PACKAGE_\|_\->meta\->table(\*(AqUser\*(Aq);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
In this recipe, we'll create a class metaclass trait which has a \*(L"table\*(R"
attribute. This trait is for classes associated with a \s-1DBMS\s0 table, as one
might do for an \s-1ORM.\s0
.PP
In this example, the table name is just a string, but in a real \s-1ORM\s0
the table might be an object describing the table.
.SH "THE METACLASS TRAIT"
.IX Header "THE METACLASS TRAIT"
This really is as simple as the recipe \*(L"\s-1SYNOPSIS\*(R"\s0 shows. The trick is
getting your classes to use this metaclass, and providing some sort of sugar
for declaring the table. This is covered in
Moose::Cookbook::Extending::Debugging_BaseClassRole, which shows how to
make a module like \f(CW\*(C`Moose.pm\*(C'\fR itself, with sugar like \f(CW\*(C`has_table()\*(C'\fR.
.SS "Using this Metaclass Trait in Practice"
.IX Subsection "Using this Metaclass Trait in Practice"
Accessing this new \f(CW\*(C`table\*(C'\fR attribute is quite simple. Given a class
named \f(CW\*(C`MyApp::User\*(C'\fR, we could simply write the following:
.PP
.Vb 1
\&  my $table = MyApp::User\->meta\->table;
.Ve
.PP
As long as \f(CW\*(C`MyApp::User\*(C'\fR has arranged to apply the
\&\f(CW\*(C`MyApp::Meta::Class::Trait::HasTable\*(C'\fR to its metaclass, this method call just
works. If we want to be more careful, we can check that the class metaclass
object has a \f(CW\*(C`table\*(C'\fR method:
.PP
.Vb 2
\&  $table = MyApp::User\->meta\->table
\&      if MyApp::User\->meta\->can(\*(Aqtable\*(Aq);
.Ve
.PP
In theory, this is not entirely correct, since the metaclass might be getting
its \f(CW\*(C`table\*(C'\fR method from a \fIdifferent\fR trait. In practice, you are unlikely
to encounter this sort of problem.
.SH "RECIPE CAVEAT"
.IX Header "RECIPE CAVEAT"
This recipe doesn't work when you paste it all into a single file. This is
because the \f(CW\*(C`use Moose \-traits => \*(AqHasTable\*(Aq;\*(C'\fR line ends up being
executed before the \f(CW\*(C`table\*(C'\fR attribute is defined.
.PP
When the two packages are separate files, this just works.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Moose::Cookbook::Meta::Labeled_AttributeTrait \- Labels implemented via
attribute traits
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
Stevan Little <stevan.little@iinteractive.com>
.IP "\(bu" 4
Dave Rolsky <autarch@urth.org>
.IP "\(bu" 4
Jesse Luehrs <doy@tozt.net>
.IP "\(bu" 4
Shawn M Moore <code@sartak.org>
.IP "\(bu" 4
\&\s-1XXXX XXX\s0'\s-1XX \s0(Yuval Kogman) <nothingmuch@woobling.org>
.IP "\(bu" 4
Karen Etheridge <ether@cpan.org>
.IP "\(bu" 4
Florian Ragwitz <rafl@debian.org>
.IP "\(bu" 4
Hans Dieter Pearcey <hdp@weftsoar.net>
.IP "\(bu" 4
Chris Prather <chris@prather.org>
.IP "\(bu" 4
Matt S Trout <mst@shadowcat.co.uk>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2006 by Infinity Interactive, Inc..
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.