Add built local::lib

[catagits/Gitalist.git] / local-lib5 / man / man3 / Moose::Cookbook.3pm

.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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.  | will give a
.\" real vertical bar.  \*(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-|\(bv\*(Tr
.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" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" 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 3"
.TH Moose::Cookbook 3 "2009-05-05" "perl v5.8.7" "User Contributed Perl Documentation"
.SH "NAME"
Moose::Cookbook \- How to cook a Moose
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The Moose cookbook is a series of recipes showing various Moose
features. Most recipes present some code demonstrating some feature,
and then explain the details of the code.
.PP
You should probably read the Moose::Manual first. The manual
explains Moose concepts without being too code\-heavy.
.SH "RECIPES"
.IX Header "RECIPES"
.Sh "Basic Moose"
.IX Subsection "Basic Moose"
These recipes will give you a good overview of Moose's capabilities, starting
with simple attribute declaration, and moving on to more powerful features like
laziness, types, type coercion, method modifiers, and more.
.IP "Moose::Cookbook::Basics::Recipe1 \- The (always classic) \fBPoint\fR example" 4
.IX Item "Moose::Cookbook::Basics::Recipe1 - The (always classic) Point example"
A simple Moose-based class. Demonstrates Moose attributes and subclassing.
.IP "Moose::Cookbook::Basics::Recipe2 \- A simple \fBBankAccount\fR example" 4
.IX Item "Moose::Cookbook::Basics::Recipe2 - A simple BankAccount example"
A slightly more complex Moose class. Demonstrates using a method
modifier in a subclass.
.IP "Moose::Cookbook::Basics::Recipe3 \- A lazy \fBBinaryTree\fR example" 4
.IX Item "Moose::Cookbook::Basics::Recipe3 - A lazy BinaryTree example"
Demonstrates several attribute features, including types, weak
references, predicates (\*(L"does this object have a foo?\*(R"), defaults,
laziness, and triggers.
.IP "Moose::Cookbook::Basics::Recipe4 \- Subtypes, and modeling a simple \fBCompany\fR class hierarchy" 4
.IX Item "Moose::Cookbook::Basics::Recipe4 - Subtypes, and modeling a simple Company class hierarchy"
Introduces the creation and use of custom types, a \f(CW\*(C`BUILD\*(C'\fR method,
and the use of \f(CW\*(C`override\*(C'\fR in a subclass.
.IP "Moose::Cookbook::Basics::Recipe5 \- More subtypes, coercion in a \fBRequest\fR class" 4
.IX Item "Moose::Cookbook::Basics::Recipe5 - More subtypes, coercion in a Request class"
More type examples, including the use of type coercions.
.IP "Moose::Cookbook::Basics::Recipe6 \- The augment/inner example" 4
.IX Item "Moose::Cookbook::Basics::Recipe6 - The augment/inner example"
Demonstrates the use of \f(CW\*(C`augment\*(C'\fR method modifiers, a way of turning
the usual method overriding style \*(L"inside\-out\*(R".
.IP "Moose::Cookbook::Basics::Recipe7 \- Making Moose fast with immutable" 4
.IX Item "Moose::Cookbook::Basics::Recipe7 - Making Moose fast with immutable"
Making a class immutable greatly increases the speed of accessors and
object construction.
.IP "Moose::Cookbook::Basics::Recipe8 \- Builder methods and lazy_build" 4
.IX Item "Moose::Cookbook::Basics::Recipe8 - Builder methods and lazy_build"
The builder feature provides an inheritable and role-composable way to
provide a default attribute value.
.IP "Moose::Cookbook::Basics::Recipe9 \- Operator overloading, subtypes, and coercion" 4
.IX Item "Moose::Cookbook::Basics::Recipe9 - Operator overloading, subtypes, and coercion"
Demonstrates using operator overloading, coercion, and subtypes to
model how eye color is determined during reproduction.
.IP "Moose::Cookbook::Basics::Recipe10 \- Using \s-1BUILDARGS\s0 and \s-1BUILD\s0 to hook into object construction" 4
.IX Item "Moose::Cookbook::Basics::Recipe10 - Using BUILDARGS and BUILD to hook into object construction"
This recipe demonstrates the use of \f(CW\*(C`BUILDARGS\*(C'\fR and \f(CW\*(C`BUILD\*(C'\fR to hook
into object construction.
.IP "Moose::Cookbook::Basics::Recipe11 \- Extending a non-Moose base class" 4
.IX Item "Moose::Cookbook::Basics::Recipe11 - Extending a non-Moose base class"
In this recipe, we make a Moose-based subclass of DateTime, a
module which does not use Moose itself.
.Sh "Moose Roles"
.IX Subsection "Moose Roles"
These recipes will show you how to use Moose roles.
.IP "Moose::Cookbook::Roles::Recipe1 \- The Moose::Role example" 4
.IX Item "Moose::Cookbook::Roles::Recipe1 - The Moose::Role example"
Demonstrates roles, which are also sometimes known as traits or
mix\-ins. Roles provide a method of code re-use which is orthogonal to
subclassing.
.IP "Moose::Cookbook::Roles::Recipe2 \- Advanced Role Composition \- method exclusion and aliasing" 4
.IX Item "Moose::Cookbook::Roles::Recipe2 - Advanced Role Composition - method exclusion and aliasing"
Sometimes you just want to include part of a role in your
class. Sometimes you want the whole role but one of its methods
conflicts with one in your class. With method exclusion and aliasing,
you can work around these problems.
.IP "Moose::Cookbook::Roles::Recipe3 \- Applying a role to an object instance" 4
.IX Item "Moose::Cookbook::Roles::Recipe3 - Applying a role to an object instance"
In this recipe, we apply a role to an existing object instance.
.Sh "Meta Moose"
.IX Subsection "Meta Moose"
These recipes show you how to write your own meta classes, which lets
you extend the object system provided by Moose.
.IP "Moose::Cookbook::Meta::Recipe1 \- Welcome to the meta-world (Why Go Meta?)" 4
.IX Item "Moose::Cookbook::Meta::Recipe1 - Welcome to the meta-world (Why Go Meta?)"
If you're wondering what all this \*(L"meta\*(R" stuff is, and why you should
care about it, read this \*(L"recipe\*(R".
.IP "Moose::Cookbook::Meta::Recipe2 \- A meta\-attribute, attributes with labels" 4
.IX Item "Moose::Cookbook::Meta::Recipe2 - A meta-attribute, attributes with labels"
One way to extend Moose is to provide your own attribute
metaclasses. Attribute metaclasses let you extend attribute
declarations (with \f(CW\*(C`has\*(C'\fR) and behavior to provide additional
attribute functionality.
.IP "Moose::Cookbook::Meta::Recipe3 \- Labels implemented via attribute traits" 4
.IX Item "Moose::Cookbook::Meta::Recipe3 - Labels implemented via attribute traits"
Extending Moose's attribute metaclass is a great way to add
functionality. However, attributes can only have one metaclass.
Applying roles to the attribute metaclass lets you provide
composable attribute functionality.
.ie n .IP "Moose::Cookbook::Meta::Recipe4 \- Adding a ""table"" attribute to the metaclass" 4
.el .IP "Moose::Cookbook::Meta::Recipe4 \- Adding a ``table'' attribute to the metaclass" 4
.IX Item "Moose::Cookbook::Meta::Recipe4 - Adding a table attribute to the metaclass"
If you want to store more information about your classes, you'll have
to extend \f(CW\*(C`Moose::Meta::Class\*(C'\fR. Doing so is simple, but you'll
probably also want to provide some sugar, so see
Moose::Cookbook::Extending::Recipe2 as well.
.ie n .IP "Moose::Cookbook::Meta::Recipe5 \- The ""table"" attribute implemented as a metaclass trait" 4
.el .IP "Moose::Cookbook::Meta::Recipe5 \- The ``table'' attribute implemented as a metaclass trait" 4
.IX Item "Moose::Cookbook::Meta::Recipe5 - The table attribute implemented as a metaclass trait"
This recipe takes the class metaclass we saw in the previous recipe
and reimplements it as a metaclass trait.
.IP "Moose::Cookbook::Meta::Recipe6 \- A method metaclass for marking methods public or private" 4
.IX Item "Moose::Cookbook::Meta::Recipe6 - A method metaclass for marking methods public or private"
This recipe shows a custom method metaclass that implements making a
method private.
.IP "Moose::Cookbook::Meta::Recipe7 \- Using a blessed array reference as an object instance" 4
.IX Item "Moose::Cookbook::Meta::Recipe7 - Using a blessed array reference as an object instance"
This recipe shows an example of how you create your own meta-instance
class. The meta-instance determines the internal structure of object
instances and provide access to attribute slots.
.IP "Moose::Cookbook::Meta::Recipe8 \- Hooking into immutabilization (\s-1TODO\s0)" 4
.IX Item "Moose::Cookbook::Meta::Recipe8 - Hooking into immutabilization (TODO)"
Moose has a feature known as \*(L"immutabilization\*(R". By calling \f(CW\*(C`_\|_PACKAGE_\|_\->meta()\->make_immutable()\*(C'\fR after defining your class
(attributes, roles, etc), you tell Moose to optimize things like
object creation, attribute access, and so on.
.Sp
If you are creating your own metaclasses, you may need to hook into
the immutabilization system. This cuts across a number of spots,
including the metaclass class, meta method classes, and possibly the
meta-instance class as well.
.Sp
This recipe shows you how to write extensions which immutabilize
properly.
.Sh "Extending Moose"
.IX Subsection "Extending Moose"
These recipes cover some more ways to extend Moose, and will be useful
if you plan to write your own \f(CW\*(C`MooseX\*(C'\fR module.
.IP "Moose::Cookbook::Extending::Recipe1 \- Moose extension overview" 4
.IX Item "Moose::Cookbook::Extending::Recipe1 - Moose extension overview"
There are quite a few ways to extend Moose. This recipe provides an
overview of each method, and provides recommendations for when each is
appropriate.
.IP "Moose::Cookbook::Extending::Recipe2 \- Providing a base object class role" 4
.IX Item "Moose::Cookbook::Extending::Recipe2 - Providing a base object class role"
Many base object class extensions can be implemented as roles. This
example shows how to provide a base object class debugging role that
is applied to any class that uses a notional \f(CW\*(C`MooseX::Debugging\*(C'\fR
module.
.IP "Moose::Cookbook::Extending::Recipe3 \- Providing an alternate base object class" 4
.IX Item "Moose::Cookbook::Extending::Recipe3 - Providing an alternate base object class"
You may find that you want to provide an alternate base object class
along with a meta extension, or maybe you just want to add some
functionality to all your classes without typing \f(CW\*(C`extends
\&'MyApp::Base'\*(C'\fR over and over.
.IP "Moose::Cookbook::Extending::Recipe4 \- Acting like Moose.pm and providing sugar Moose-style" 4
.IX Item "Moose::Cookbook::Extending::Recipe4 - Acting like Moose.pm and providing sugar Moose-style"
This recipe shows how to provide a replacement for \f(CW\*(C`Moose.pm\*(C'\fR. You
may want to do this as part of the \s-1API\s0 for a \f(CW\*(C`MooseX\*(C'\fR module,
especially if you want to default to a new metaclass class or base
object class.
.SH "SNACKS"
.IX Header "SNACKS"
.IP "Moose::Cookbook::Snack::Keywords" 4
.IX Item "Moose::Cookbook::Snack::Keywords"
.PD 0
.IP "Moose::Cookbook::Snack::Types" 4
.IX Item "Moose::Cookbook::Snack::Types"
.PD
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "<http://www.gsph.com/index.php?Lang=En&ID=291>" 4
.IX Item "<http://www.gsph.com/index.php?Lang=En&ID=291>"
.SH "AUTHOR"
.IX Header "AUTHOR"
Stevan Little <stevan@iinteractive.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2006\-2009 by Infinity Interactive, Inc.
.PP
<http://www.iinteractive.com>
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.