projects / catagits/Gitalist.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | history | HEAD
Add built local::lib
[catagits/Gitalist.git] / local-lib5 / man / man3 / Moose::Cookbook::Extending::Recipe4.3pm
CommitLineData
3fea05b9 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::Extending::Recipe4 3"
132.TH Moose::Cookbook::Extending::Recipe4 3 "2009-09-12" "perl v5.8.7" "User Contributed Perl Documentation"
133.SH "NAME"
134Moose::Cookbook::Extending::Recipe4 \- Acting like Moose.pm and providing sugar Moose\-style
135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS"
137.Vb 1
138\& package MyApp::Mooseish;
139.Ve
140.PP
141.Vb 2
142\& use Moose ();
143\& use Moose::Exporter;
144.Ve
145.PP
146.Vb 4
147\& Moose::Exporter\->setup_import_methods(
148\& with_meta => ['has_table'],
149\& also => 'Moose',
150\& );
151.Ve
152.PP
153.Vb 4
154\& sub init_meta {
155\& shift;
156\& return Moose\->init_meta( @_, metaclass => 'MyApp::Meta::Class' );
157\& }
158.Ve
159.PP
160.Vb 4
161\& sub has_table {
162\& my $meta = shift;
163\& $meta\->table(shift);
164\& }
165.Ve
166.PP
167.Vb 2
168\& package MyApp::Meta::Class;
169\& use Moose;
170.Ve
171.PP
172.Vb 1
173\& extends 'Moose::Meta::Class';
174.Ve
175.PP
176.Vb 1
177\& has 'table' => ( is => 'rw' );
178.Ve
179.SH "DESCRIPTION"
180.IX Header "DESCRIPTION"
181This recipe expands on the use of Moose::Exporter we saw in
182Moose::Cookbook::Extending::Recipe1. Instead of providing our own
183object base class, we provide our own metaclass class, and we also
184export a \f(CW\*(C`has_table\*(C'\fR sugar function.
185.PP
186Given the above code, you can now replace all instances of \f(CW\*(C`use
187Moose\*(C'\fR with \f(CW\*(C`use MyApp::Mooseish\*(C'\fR. Similarly, \f(CW\*(C`no Moose\*(C'\fR is now
188replaced with \f(CW\*(C`no MyApp::Mooseish\*(C'\fR.
189.PP
190The \f(CW\*(C`with_meta\*(C'\fR parameter specifies a list of functions that should
191be wrapped before exporting. The wrapper simply ensures that the
192importing package name is the first argument to the function, so we
193can do \f(CW\*(C`my\ \f(CW$caller\f(CW\ =\ shift;\*(C'\fR.
194.PP
195See the Moose::Exporter docs for more details on its \s-1API\s0.
196.SH "USING MyApp::Mooseish"
197.IX Header "USING MyApp::Mooseish"
198The purpose of all this code is to provide a Moose-like
199interface. Here's what it would look like in actual use:
200.PP
201.Vb 1
202\& package MyApp::User;
203.Ve
204.PP
205.Vb 1
206\& use MyApp::Mooseish;
207.Ve
208.PP
209.Vb 1
210\& has_table 'User';
211.Ve
212.PP
213.Vb 2
214\& has 'username' => ( is => 'ro' );
215\& has 'password' => ( is => 'ro' );
216.Ve
217.PP
218.Vb 1
219\& sub login { ... }
220.Ve
221.PP
222.Vb 1
223\& no MyApp::Mooseish;
224.Ve
225.PP
226All of the normal Moose sugar (\f(CW\*(C`has()\*(C'\fR, \f(CW\*(C`with()\*(C'\fR, etc) is available
227when you \f(CW\*(C`use MyApp::Mooseish\*(C'\fR.
228.SH "CONCLUSION"
229.IX Header "CONCLUSION"
230Providing sugar functions can make your extension look much more
231Moose\-ish. See Fey::ORM for a more extensive example.
232.SH "AUTHOR"
233.IX Header "AUTHOR"
234Dave Rolsky <autarch@urth.org>
235.SH "COPYRIGHT AND LICENSE"
236.IX Header "COPYRIGHT AND LICENSE"
237Copyright 2006\-2009 by Infinity Interactive, Inc.
238.PP
239<http://www.iinteractive.com>
240.PP
241This library is free software; you can redistribute it and/or modify
242it under the same terms as Perl itself.
Git web viewer in Catalyst