Commit | Line | Data |
8b978dd5 |
1 | |
2 | package Class::MOP::Attribute; |
3 | |
4 | use strict; |
5 | use warnings; |
6 | |
ba38bf08 |
7 | use Class::MOP::Method::Accessor; |
8 | |
2eb717d5 |
9 | use Carp 'confess'; |
9ec169fe |
10 | use Scalar::Util 'blessed', 'reftype', 'weaken'; |
2eb717d5 |
11 | |
d7b2249e |
12 | our $VERSION = '0.24'; |
f0480c45 |
13 | our $AUTHORITY = 'cpan:STEVAN'; |
8b978dd5 |
14 | |
b1897d4d |
15 | use base 'Class::MOP::Object'; |
16 | |
727919c5 |
17 | # NOTE: (meta-circularity) |
1d68af04 |
18 | # This method will be replaced in the |
19 | # boostrap section of Class::MOP, by |
20 | # a new version which uses the |
727919c5 |
21 | # &Class::MOP::Class::construct_instance |
22 | # method to build an attribute meta-object |
23 | # which itself is described with attribute |
1d68af04 |
24 | # meta-objects. |
727919c5 |
25 | # - Ain't meta-circularity grand? :) |
8b978dd5 |
26 | sub new { |
27 | my $class = shift; |
28 | my $name = shift; |
1d68af04 |
29 | my %options = @_; |
30 | |
cbd9f942 |
31 | (defined $name && $name) |
8b978dd5 |
32 | || confess "You must provide a name for the attribute"; |
1d68af04 |
33 | |
34 | $options{init_arg} = $name |
5659d76e |
35 | if not exists $options{init_arg}; |
1d68af04 |
36 | if(exists $options{builder}){ |
37 | confess("builder must be a defined scalar value which is a method name") |
38 | if ref $options{builder} || !(defined $options{builder}); |
39 | confess("Setting both default and builder is not allowed.") |
40 | if exists $options{default}; |
8fe581e5 |
41 | } else { |
42 | (is_default_a_coderef(\%options)) |
43 | || confess("References are not allowed as default values, you must ". |
44 | "wrap then in a CODE reference (ex: sub { [] } and not [])") |
45 | if exists $options{default} && ref $options{default}; |
1d68af04 |
46 | } |
2e877f58 |
47 | if( $options{required} and not( defined($options{builder}) || defined($options{init_arg}) || exists $options{default} ) ) { |
48 | confess("A required attribute must have either 'init_arg', 'builder', or 'default'"); |
49 | } |
8b978dd5 |
50 | bless { |
c23184fc |
51 | '$!name' => $name, |
52 | '$!accessor' => $options{accessor}, |
53 | '$!reader' => $options{reader}, |
8ee74136 |
54 | '$!writer' => $options{writer}, |
55 | '$!predicate' => $options{predicate}, |
56 | '$!clearer' => $options{clearer}, |
57 | '$!builder' => $options{builder}, |
58 | '$!init_arg' => $options{init_arg}, |
59 | '$!default' => $options{default}, |
60 | '$!initializer' => $options{initializer}, |
1d68af04 |
61 | # keep a weakened link to the |
9ec169fe |
62 | # class we are associated with |
c23184fc |
63 | '$!associated_class' => undef, |
1d68af04 |
64 | # and a list of the methods |
3545c727 |
65 | # associated with this attr |
c23184fc |
66 | '@!associated_methods' => [], |
8ee74136 |
67 | # NOTE: |
68 | # protect this from silliness |
2e5a2a62 |
69 | init_arg => undef, |
8b978dd5 |
70 | } => $class; |
71 | } |
72 | |
7b31baf4 |
73 | # NOTE: |
1d68af04 |
74 | # this is a primative (and kludgy) clone operation |
16e960bd |
75 | # for now, it will be replaced in the Class::MOP |
1d68af04 |
76 | # bootstrap with a proper one, however we know |
5659d76e |
77 | # that this one will work fine for now. |
78 | sub clone { |
79 | my $self = shift; |
80 | my %options = @_; |
81 | (blessed($self)) |
82 | || confess "Can only clone an instance"; |
83 | return bless { %{$self}, %options } => blessed($self); |
84 | } |
85 | |
bd4e03f9 |
86 | sub initialize_instance_slot { |
f892c0f0 |
87 | my ($self, $meta_instance, $instance, $params) = @_; |
c23184fc |
88 | my $init_arg = $self->{'$!init_arg'}; |
bd4e03f9 |
89 | # try to fetch the init arg from the %params ... |
8d2d4c67 |
90 | |
1d68af04 |
91 | # if nothing was in the %params, we can use the |
bd4e03f9 |
92 | # attribute's default value (if it has one) |
2e877f58 |
93 | if(defined $init_arg and exists $params->{$init_arg}){ |
8ee74136 |
94 | $self->_set_initial_slot_value( |
95 | $meta_instance, |
0ab65f99 |
96 | $instance, |
0ab65f99 |
97 | $params->{$init_arg}, |
0ab65f99 |
98 | ); |
b7bdffc3 |
99 | } |
100 | elsif (defined $self->{'$!default'}) { |
8ee74136 |
101 | $self->_set_initial_slot_value( |
102 | $meta_instance, |
0ab65f99 |
103 | $instance, |
0ab65f99 |
104 | $self->default($instance), |
0ab65f99 |
105 | ); |
b7bdffc3 |
106 | } |
107 | elsif (defined( my $builder = $self->{'$!builder'})) { |
108 | if ($builder = $instance->can($builder)) { |
8ee74136 |
109 | $self->_set_initial_slot_value( |
110 | $meta_instance, |
0ab65f99 |
111 | $instance, |
0ab65f99 |
112 | $instance->$builder, |
0ab65f99 |
113 | ); |
b7bdffc3 |
114 | } |
115 | else { |
232c4e13 |
116 | confess(blessed($instance)." does not support builder method '". $self->{'$!builder'} ."' for attribute '" . $self->name . "'"); |
8fe581e5 |
117 | } |
1d68af04 |
118 | } |
bd4e03f9 |
119 | } |
120 | |
8ee74136 |
121 | sub _set_initial_slot_value { |
122 | my ($self, $meta_instance, $instance, $value) = @_; |
123 | |
124 | my $slot_name = $self->name; |
125 | |
126 | return $meta_instance->set_slot_value($instance, $slot_name, $value) |
127 | unless $self->has_initializer; |
128 | |
129 | my $callback = sub { |
130 | $meta_instance->set_slot_value($instance, $slot_name, $_[0]); |
131 | }; |
132 | |
133 | my $initializer = $self->initializer; |
134 | |
135 | # most things will just want to set a value, so make it first arg |
136 | $instance->$initializer($value, $callback, $self); |
137 | } |
138 | |
5659d76e |
139 | # NOTE: |
1d68af04 |
140 | # the next bunch of methods will get bootstrapped |
7b31baf4 |
141 | # away in the Class::MOP bootstrapping section |
142 | |
c23184fc |
143 | sub name { $_[0]->{'$!name'} } |
c50c603e |
144 | |
c23184fc |
145 | sub associated_class { $_[0]->{'$!associated_class'} } |
146 | sub associated_methods { $_[0]->{'@!associated_methods'} } |
7b31baf4 |
147 | |
8ee74136 |
148 | sub has_accessor { defined($_[0]->{'$!accessor'}) ? 1 : 0 } |
149 | sub has_reader { defined($_[0]->{'$!reader'}) ? 1 : 0 } |
150 | sub has_writer { defined($_[0]->{'$!writer'}) ? 1 : 0 } |
151 | sub has_predicate { defined($_[0]->{'$!predicate'}) ? 1 : 0 } |
152 | sub has_clearer { defined($_[0]->{'$!clearer'}) ? 1 : 0 } |
153 | sub has_builder { defined($_[0]->{'$!builder'}) ? 1 : 0 } |
154 | sub has_init_arg { defined($_[0]->{'$!init_arg'}) ? 1 : 0 } |
155 | sub has_default { defined($_[0]->{'$!default'}) ? 1 : 0 } |
0ab65f99 |
156 | sub has_initializer { defined($_[0]->{'$!initializer'}) ? 1 : 0 } |
c50c603e |
157 | |
8ee74136 |
158 | sub accessor { $_[0]->{'$!accessor'} } |
159 | sub reader { $_[0]->{'$!reader'} } |
160 | sub writer { $_[0]->{'$!writer'} } |
161 | sub predicate { $_[0]->{'$!predicate'} } |
162 | sub clearer { $_[0]->{'$!clearer'} } |
163 | sub builder { $_[0]->{'$!builder'} } |
164 | sub init_arg { $_[0]->{'$!init_arg'} } |
0ab65f99 |
165 | sub initializer { $_[0]->{'$!initializer'} } |
c50c603e |
166 | |
7b31baf4 |
167 | # end bootstrapped away method section. |
168 | # (all methods below here are kept intact) |
169 | |
9e517e01 |
170 | sub has_read_method { $_[0]->has_reader || $_[0]->has_accessor } |
171 | sub has_write_method { $_[0]->has_writer || $_[0]->has_accessor } |
172 | |
d14f6cbe |
173 | sub get_read_method { |
174 | my $self = shift; |
175 | my $reader = $self->reader || $self->accessor; |
176 | # normal case ... |
177 | return $reader unless ref $reader; |
178 | # the HASH ref case |
179 | my ($name) = %$reader; |
180 | return $name; |
181 | } |
182 | |
183 | sub get_write_method { |
184 | my $self = shift; |
185 | my $writer = $self->writer || $self->accessor; |
186 | # normal case ... |
187 | return $writer unless ref $writer; |
188 | # the HASH ref case |
189 | my ($name) = %$writer; |
190 | return $name; |
191 | } |
b25109b1 |
192 | |
5da16d1b |
193 | sub get_read_method_ref { |
194 | my $self = shift; |
742fb371 |
195 | if ((my $reader = $self->get_read_method) && $self->associated_class) { |
5da16d1b |
196 | return $self->associated_class->get_method($reader); |
197 | } |
198 | else { |
199 | return sub { $self->get_value(@_) }; |
200 | } |
201 | } |
202 | |
203 | sub get_write_method_ref { |
204 | my $self = shift; |
d14f6cbe |
205 | if ((my $writer = $self->get_write_method) && $self->associated_class) { |
742fb371 |
206 | return $self->associated_class->get_method($writer); |
5da16d1b |
207 | } |
208 | else { |
209 | return sub { $self->set_value(@_) }; |
210 | } |
211 | } |
212 | |
1d68af04 |
213 | sub is_default_a_coderef { |
214 | ('CODE' eq (reftype($_[0]->{'$!default'} || $_[0]->{default}) || '')) |
c0cbf4d9 |
215 | } |
216 | |
1d68af04 |
217 | sub default { |
c0cbf4d9 |
218 | my ($self, $instance) = @_; |
9363ea89 |
219 | if (defined $instance && $self->is_default_a_coderef) { |
1d68af04 |
220 | # if the default is a CODE ref, then |
727919c5 |
221 | # we pass in the instance and default |
1d68af04 |
222 | # can return a value based on that |
727919c5 |
223 | # instance. Somewhat crude, but works. |
c23184fc |
224 | return $self->{'$!default'}->($instance); |
1d68af04 |
225 | } |
c23184fc |
226 | $self->{'$!default'}; |
c50c603e |
227 | } |
8b978dd5 |
228 | |
c57c8b10 |
229 | # slots |
230 | |
231 | sub slots { (shift)->name } |
232 | |
1d68af04 |
233 | # class association |
727919c5 |
234 | |
9ec169fe |
235 | sub attach_to_class { |
236 | my ($self, $class) = @_; |
237 | (blessed($class) && $class->isa('Class::MOP::Class')) |
238 | || confess "You must pass a Class::MOP::Class instance (or a subclass)"; |
1d68af04 |
239 | weaken($self->{'$!associated_class'} = $class); |
9ec169fe |
240 | } |
241 | |
242 | sub detach_from_class { |
243 | my $self = shift; |
1d68af04 |
244 | $self->{'$!associated_class'} = undef; |
9ec169fe |
245 | } |
246 | |
1d68af04 |
247 | # method association |
3545c727 |
248 | |
249 | sub associate_method { |
250 | my ($self, $method) = @_; |
c23184fc |
251 | push @{$self->{'@!associated_methods'}} => $method; |
3545c727 |
252 | } |
253 | |
16e960bd |
254 | ## Slot management |
255 | |
ef91a0e2 |
256 | sub set_initial_value { |
257 | my ($self, $instance, $value) = @_; |
e76b01fb |
258 | $self->_set_initial_slot_value( |
da34f054 |
259 | Class::MOP::Class->initialize(blessed($instance))->get_meta_instance, |
8ee74136 |
260 | $instance, |
261 | $value |
262 | ); |
ef91a0e2 |
263 | } |
264 | |
16e960bd |
265 | sub set_value { |
1396f86b |
266 | my ($self, $instance, $value) = @_; |
16e960bd |
267 | |
da34f054 |
268 | Class::MOP::Class->initialize(blessed($instance)) |
269 | ->get_meta_instance |
270 | ->set_slot_value($instance, $self->name, $value); |
16e960bd |
271 | } |
272 | |
273 | sub get_value { |
1396f86b |
274 | my ($self, $instance) = @_; |
16e960bd |
275 | |
da34f054 |
276 | Class::MOP::Class->initialize(blessed($instance)) |
277 | ->get_meta_instance |
278 | ->get_slot_value($instance, $self->name); |
16e960bd |
279 | } |
280 | |
3545c727 |
281 | sub has_value { |
282 | my ($self, $instance) = @_; |
1d68af04 |
283 | |
da34f054 |
284 | Class::MOP::Class->initialize(blessed($instance)) |
285 | ->get_meta_instance |
286 | ->is_slot_initialized($instance, $self->name); |
3545c727 |
287 | } |
288 | |
289 | sub clear_value { |
290 | my ($self, $instance) = @_; |
1d68af04 |
291 | |
da34f054 |
292 | Class::MOP::Class->initialize(blessed($instance)) |
293 | ->get_meta_instance |
294 | ->deinitialize_slot($instance, $self->name); |
3545c727 |
295 | } |
296 | |
ba38bf08 |
297 | ## load em up ... |
c0cbf4d9 |
298 | |
ba38bf08 |
299 | sub accessor_metaclass { 'Class::MOP::Method::Accessor' } |
c0cbf4d9 |
300 | |
9ec169fe |
301 | sub process_accessors { |
c0cbf4d9 |
302 | my ($self, $type, $accessor, $generate_as_inline_methods) = @_; |
013b1897 |
303 | if (reftype($accessor)) { |
304 | (reftype($accessor) eq 'HASH') |
7d28758b |
305 | || confess "bad accessor/reader/writer/predicate/clearer format, must be a HASH ref"; |
4d47b77f |
306 | my ($name, $method) = %{$accessor}; |
3545c727 |
307 | $method = $self->accessor_metaclass->wrap($method); |
308 | $self->associate_method($method); |
1d68af04 |
309 | return ($name, $method); |
2eb717d5 |
310 | } |
9ec169fe |
311 | else { |
1d68af04 |
312 | my $inline_me = ($generate_as_inline_methods && $self->associated_class->instance_metaclass->is_inlinable); |
ba38bf08 |
313 | my $method; |
314 | eval { |
315 | $method = $self->accessor_metaclass->new( |
316 | attribute => $self, |
d90b42a6 |
317 | is_inline => $inline_me, |
ba38bf08 |
318 | accessor_type => $type, |
1d68af04 |
319 | ); |
ba38bf08 |
320 | }; |
1d68af04 |
321 | confess "Could not create the '$type' method for " . $self->name . " because : $@" if $@; |
3545c727 |
322 | $self->associate_method($method); |
ba38bf08 |
323 | return ($accessor, $method); |
1d68af04 |
324 | } |
9ec169fe |
325 | } |
326 | |
327 | sub install_accessors { |
c0cbf4d9 |
328 | my $self = shift; |
329 | my $inline = shift; |
330 | my $class = $self->associated_class; |
1d68af04 |
331 | |
9ec169fe |
332 | $class->add_method( |
c0cbf4d9 |
333 | $self->process_accessors('accessor' => $self->accessor(), $inline) |
9ec169fe |
334 | ) if $self->has_accessor(); |
335 | |
1d68af04 |
336 | $class->add_method( |
c0cbf4d9 |
337 | $self->process_accessors('reader' => $self->reader(), $inline) |
9ec169fe |
338 | ) if $self->has_reader(); |
339 | |
340 | $class->add_method( |
c0cbf4d9 |
341 | $self->process_accessors('writer' => $self->writer(), $inline) |
9ec169fe |
342 | ) if $self->has_writer(); |
343 | |
344 | $class->add_method( |
c0cbf4d9 |
345 | $self->process_accessors('predicate' => $self->predicate(), $inline) |
9ec169fe |
346 | ) if $self->has_predicate(); |
1d68af04 |
347 | |
7d28758b |
348 | $class->add_method( |
349 | $self->process_accessors('clearer' => $self->clearer(), $inline) |
350 | ) if $self->has_clearer(); |
1d68af04 |
351 | |
9ec169fe |
352 | return; |
2eb717d5 |
353 | } |
354 | |
b51af7f9 |
355 | { |
356 | my $_remove_accessor = sub { |
357 | my ($accessor, $class) = @_; |
c50c603e |
358 | if (reftype($accessor) && reftype($accessor) eq 'HASH') { |
359 | ($accessor) = keys %{$accessor}; |
1d68af04 |
360 | } |
361 | my $method = $class->get_method($accessor); |
362 | $class->remove_method($accessor) |
ba38bf08 |
363 | if (blessed($method) && $method->isa('Class::MOP::Method::Accessor')); |
b51af7f9 |
364 | }; |
1d68af04 |
365 | |
b51af7f9 |
366 | sub remove_accessors { |
9ec169fe |
367 | my $self = shift; |
2367814a |
368 | # TODO: |
1d68af04 |
369 | # we really need to make sure to remove from the |
370 | # associates methods here as well. But this is |
371 | # such a slimly used method, I am not worried |
2367814a |
372 | # about it right now. |
9ec169fe |
373 | $_remove_accessor->($self->accessor(), $self->associated_class()) if $self->has_accessor(); |
374 | $_remove_accessor->($self->reader(), $self->associated_class()) if $self->has_reader(); |
375 | $_remove_accessor->($self->writer(), $self->associated_class()) if $self->has_writer(); |
376 | $_remove_accessor->($self->predicate(), $self->associated_class()) if $self->has_predicate(); |
7d28758b |
377 | $_remove_accessor->($self->clearer(), $self->associated_class()) if $self->has_clearer(); |
1d68af04 |
378 | return; |
b51af7f9 |
379 | } |
380 | |
8b978dd5 |
381 | } |
382 | |
383 | 1; |
384 | |
385 | __END__ |
386 | |
387 | =pod |
388 | |
1d68af04 |
389 | =head1 NAME |
8b978dd5 |
390 | |
391 | Class::MOP::Attribute - Attribute Meta Object |
392 | |
393 | =head1 SYNOPSIS |
1d68af04 |
394 | |
8b978dd5 |
395 | Class::MOP::Attribute->new('$foo' => ( |
fe122940 |
396 | accessor => 'foo', # dual purpose get/set accessor |
1d68af04 |
397 | predicate => 'has_foo' # predicate check for defined-ness |
fe122940 |
398 | init_arg => '-foo', # class->new will look for a -foo key |
399 | default => 'BAR IS BAZ!' # if no -foo key is provided, use this |
8b978dd5 |
400 | )); |
1d68af04 |
401 | |
8b978dd5 |
402 | Class::MOP::Attribute->new('$.bar' => ( |
fe122940 |
403 | reader => 'bar', # getter |
1d68af04 |
404 | writer => 'set_bar', # setter |
405 | predicate => 'has_bar' # predicate check for defined-ness |
fe122940 |
406 | init_arg => ':bar', # class->new will look for a :bar key |
8b978dd5 |
407 | # no default value means it is undef |
408 | )); |
409 | |
410 | =head1 DESCRIPTION |
411 | |
fe122940 |
412 | The Attribute Protocol is almost entirely an invention of this module, |
1d68af04 |
413 | and is completely optional to this MOP. This is because Perl 5 does not |
414 | have consistent notion of what is an attribute of a class. There are |
415 | so many ways in which this is done, and very few (if any) are |
fe122940 |
416 | easily discoverable by this module. |
552e3d24 |
417 | |
1d68af04 |
418 | So, all that said, this module attempts to inject some order into this |
419 | chaos, by introducing a consistent API which can be used to create |
fe122940 |
420 | object attributes. |
552e3d24 |
421 | |
422 | =head1 METHODS |
423 | |
424 | =head2 Creation |
425 | |
426 | =over 4 |
427 | |
fe122940 |
428 | =item B<new ($name, ?%options)> |
429 | |
1d68af04 |
430 | An attribute must (at the very least), have a C<$name>. All other |
a2e85e6c |
431 | C<%options> are contained added as key-value pairs. Acceptable keys |
fe122940 |
432 | are as follows: |
433 | |
434 | =over 4 |
435 | |
436 | =item I<init_arg> |
437 | |
1d68af04 |
438 | This should be a string value representing the expected key in |
439 | an initialization hash. For instance, if we have an I<init_arg> |
fe122940 |
440 | value of C<-foo>, then the following code will Just Work. |
441 | |
442 | MyClass->meta->construct_instance(-foo => "Hello There"); |
443 | |
1d68af04 |
444 | In an init_arg is not assigned, it will automatically use the |
0ef07b33 |
445 | value of C<$name>. If an explicit C<undef> is given for an init_arg, |
446 | an attribute value can't be specified during initialization. |
7b31baf4 |
447 | |
1d68af04 |
448 | =item I<builder> |
449 | |
450 | The value of this key is the name of the method that will be |
451 | called to obtain the value used to initialize the attribute. |
452 | This should be a method in the class associated with the attribute, |
453 | not a method in the attribute class itself. |
fe122940 |
454 | |
4c4a6c41 |
455 | =item I<default> |
456 | |
457 | The value of this key is the default value which |
458 | C<Class::MOP::Class::construct_instance> will initialize the |
459 | attribute to. |
460 | |
fe122940 |
461 | B<NOTE:> |
1d68af04 |
462 | If the value is a simple scalar (string or number), then it can |
463 | be just passed as is. However, if you wish to initialize it with |
464 | a HASH or ARRAY ref, then you need to wrap that inside a CODE |
fe122940 |
465 | reference, like so: |
466 | |
467 | Class::MOP::Attribute->new('@foo' => ( |
468 | default => sub { [] }, |
469 | )); |
1d68af04 |
470 | |
471 | # or ... |
472 | |
fe122940 |
473 | Class::MOP::Attribute->new('%foo' => ( |
474 | default => sub { {} }, |
1d68af04 |
475 | )); |
fe122940 |
476 | |
1d68af04 |
477 | If you wish to initialize an attribute with a CODE reference |
fe122940 |
478 | itself, then you need to wrap that in a subroutine as well, like |
479 | so: |
1d68af04 |
480 | |
fe122940 |
481 | Class::MOP::Attribute->new('&foo' => ( |
482 | default => sub { sub { print "Hello World" } }, |
483 | )); |
484 | |
1d68af04 |
485 | And lastly, if the value of your attribute is dependent upon |
486 | some other aspect of the instance structure, then you can take |
487 | advantage of the fact that when the I<default> value is a CODE |
127d39a7 |
488 | reference, it is passed the (as yet unfinished) instance structure |
fe122940 |
489 | as it's only argument. So you can do things like this: |
490 | |
491 | Class::MOP::Attribute->new('$object_identity' => ( |
492 | default => sub { Scalar::Util::refaddr($_[0]) }, |
493 | )); |
494 | |
1d68af04 |
495 | This last feature is fairly limited as there is no gurantee of |
496 | the order of attribute initializations, so you cannot perform |
497 | any kind of dependent initializations. However, if this is |
498 | something you need, you could subclass B<Class::MOP::Class> and |
499 | this class to acheive it. However, this is currently left as |
fe122940 |
500 | an exercise to the reader :). |
501 | |
0ef07b33 |
502 | =item I<initializer> |
503 | |
504 | This may be a method name (referring to a method on the class with this |
505 | attribute) or a CODE ref. The initializer is used to set the attribute value |
506 | on an instance when the attribute is set during instance initialization. When |
507 | called, it is passed the instance (as the invocant), the value to set, a |
508 | slot-setting CODE ref, and the attribute meta-instance. The slot-setting code |
509 | is provided to make it easy to set the (possibly altered) value on the instance |
510 | without going through several more method calls. |
511 | |
0ef07b33 |
512 | This contrived example shows an initializer that sets the attribute to twice |
513 | the given value. |
514 | |
515 | Class::MOP::Attribute->new('$doubled' => ( |
516 | initializer => sub { |
517 | my ($instance, $value, $set) = @_; |
518 | $set->($value * 2); |
519 | }, |
520 | )); |
521 | |
522 | As method names can be given as initializers, one can easily make |
523 | attribute initialization use the writer: |
524 | |
525 | Class::MOP::Attribute->new('$some_attr' => ( |
526 | writer => 'some_attr', |
527 | initializer => 'some_attr', |
528 | )); |
529 | |
127d39a7 |
530 | Your writer will simply need to examine it's C<@_> and determine under |
531 | which context it is being called. |
532 | |
fe122940 |
533 | =back |
534 | |
7d28758b |
535 | The I<accessor>, I<reader>, I<writer>, I<predicate> and I<clearer> keys can |
536 | contain either; the name of the method and an appropriate default one will be |
537 | generated for you, B<or> a HASH ref containing exactly one key (which will be |
538 | used as the name of the method) and one value, which should contain a CODE |
539 | reference which will be installed as the method itself. |
59e7697f |
540 | |
541 | =over 4 |
542 | |
543 | =item I<accessor> |
544 | |
1d68af04 |
545 | The I<accessor> is a standard perl-style read/write accessor. It will |
546 | return the value of the attribute, and if a value is passed as an argument, |
fe122940 |
547 | it will assign that value to the attribute. |
548 | |
549 | B<NOTE:> |
1d68af04 |
550 | This method will properly handle the following code, by assigning an |
fe122940 |
551 | C<undef> value to the attribute. |
552 | |
553 | $object->set_something(undef); |
554 | |
59e7697f |
555 | =item I<reader> |
556 | |
1d68af04 |
557 | This is a basic read-only accessor, it will just return the value of |
fe122940 |
558 | the attribute. |
559 | |
59e7697f |
560 | =item I<writer> |
561 | |
1d68af04 |
562 | This is a basic write accessor, it accepts a single argument, and |
563 | assigns that value to the attribute. This method does not intentially |
564 | return a value, however perl will return the result of the last |
565 | expression in the subroutine, which returns in this returning the |
566 | same value that it was passed. |
59e7697f |
567 | |
fe122940 |
568 | B<NOTE:> |
1d68af04 |
569 | This method will properly handle the following code, by assigning an |
fe122940 |
570 | C<undef> value to the attribute. |
59e7697f |
571 | |
fe122940 |
572 | $object->set_something(); |
573 | |
574 | =item I<predicate> |
575 | |
07dca7e3 |
576 | This is a basic test to see if any value has been set for the |
577 | attribute. It will return true (C<1>) if the attribute has been set |
578 | to any value (even C<undef>), and false (C<0>) otherwise. |
579 | |
580 | B<NOTE:> |
581 | The predicate will return true even when you set an attribute's |
582 | value to C<undef>. This behaviour has changed as of version 0.43. In |
583 | older versions, the predicate (erroneously) checked for attribute |
584 | value definedness, instead of presence as it is now. |
585 | |
586 | If you really want to get rid of the value, you have to define and |
587 | use a I<clearer> (see below). |
588 | |
7d28758b |
589 | =item I<clearer> |
590 | |
591 | This is the a method that will uninitialize the attr, reverting lazy values |
592 | back to their "unfulfilled" state. |
593 | |
59e7697f |
594 | =back |
552e3d24 |
595 | |
bd4e03f9 |
596 | =item B<clone (%options)> |
597 | |
127d39a7 |
598 | This will return a clone of the attribute instance, allowing the overriding |
599 | of various attributes through the C<%options> supplied. |
600 | |
bd4e03f9 |
601 | =item B<initialize_instance_slot ($instance, $params)> |
602 | |
127d39a7 |
603 | This method is used internally to initialize the approriate slot for this |
604 | attribute in a given C<$instance>, the C<$params> passed are those that were |
605 | passed to the constructor. |
606 | |
1d68af04 |
607 | =back |
552e3d24 |
608 | |
16e960bd |
609 | =head2 Value management |
610 | |
1d68af04 |
611 | These methods are basically "backdoors" to the instance, which can be used |
612 | to bypass the regular accessors, but still stay within the context of the MOP. |
2367814a |
613 | |
1d68af04 |
614 | These methods are not for general use, and should only be used if you really |
2367814a |
615 | know what you are doing. |
616 | |
16e960bd |
617 | =over 4 |
618 | |
3545c727 |
619 | =item B<set_value ($instance, $value)> |
16e960bd |
620 | |
621 | Set the value without going through the accessor. Note that this may be done to |
622 | even attributes with just read only accessors. |
623 | |
c0921932 |
624 | =item B<set_initial_value ($instance, $value)> |
625 | |
626 | This method sets the value without going through the accessor -- but it is only |
627 | called when the instance data is first initialized. |
628 | |
3545c727 |
629 | =item B<get_value ($instance)> |
16e960bd |
630 | |
631 | Return the value without going through the accessor. Note that this may be done |
632 | even to attributes with just write only accessors. |
633 | |
3545c727 |
634 | =item B<has_value ($instance)> |
635 | |
92d2abfa |
636 | Return a boolean indicating if the item in the C<$instance> has a value in it. |
2367814a |
637 | This is basically what the default C<predicate> method calls. |
638 | |
3545c727 |
639 | =item B<clear_value ($instance)> |
640 | |
2367814a |
641 | This will clear the value in the C<$instance>. This is basically what the default |
1d68af04 |
642 | C<clearer> would call. Note that this may be done even if the attirbute does not |
2367814a |
643 | have any associated read, write or clear methods. |
644 | |
16e960bd |
645 | =back |
646 | |
552e3d24 |
647 | =head2 Informational |
648 | |
1d68af04 |
649 | These are all basic read-only value accessors for the values |
fe122940 |
650 | passed into C<new>. I think they are pretty much self-explanitory. |
651 | |
552e3d24 |
652 | =over 4 |
653 | |
654 | =item B<name> |
655 | |
656 | =item B<accessor> |
657 | |
658 | =item B<reader> |
659 | |
660 | =item B<writer> |
661 | |
c50c603e |
662 | =item B<predicate> |
663 | |
7d28758b |
664 | =item B<clearer> |
665 | |
0ab65f99 |
666 | =item B<initializer> |
667 | |
552e3d24 |
668 | =item B<init_arg> |
669 | |
495af518 |
670 | =item B<is_default_a_coderef> |
671 | |
fe122940 |
672 | =item B<default (?$instance)> |
673 | |
92d2abfa |
674 | Return the default value for the attribute. |
675 | |
676 | If you pass in an C<$instance> argument to this accessor and the |
677 | I<default> is a CODE reference, then the CODE reference will be |
678 | executed with the C<$instance> as its argument. |
552e3d24 |
679 | |
c57c8b10 |
680 | =item B<slots> |
681 | |
92d2abfa |
682 | Return a list of slots required by the attribute. This is usually |
c57c8b10 |
683 | just one, which is the name of the attribute. |
684 | |
b25109b1 |
685 | =item B<get_read_method> |
686 | |
687 | =item B<get_write_method> |
688 | |
5da16d1b |
689 | Return the name of a method name suitable for reading / writing the value |
690 | of the attribute in the associated class. Suitable for use whether |
691 | C<reader> and C<writer> or C<accessor> was used. |
692 | |
693 | =item B<get_read_method_ref> |
694 | |
695 | =item B<get_write_method_ref> |
696 | |
697 | Return the CODE reference of a method suitable for reading / writing the |
698 | value of the attribute in the associated class. Suitable for use whether |
699 | C<reader> and C<writer> or C<accessor> was specified or not. |
700 | |
127d39a7 |
701 | NOTE: If no reader/writer/accessor was specified, this will use the |
5da16d1b |
702 | attribute get_value/set_value methods, which can be very inefficient. |
b25109b1 |
703 | |
9e517e01 |
704 | =item B<has_read_method> |
705 | |
706 | =item B<has_write_method> |
707 | |
708 | Return whether a method exists suitable for reading / writing the value |
709 | of the attribute in the associated class. Suitable for use whether |
710 | C<reader> and C<writer> or C<accessor> was used. |
711 | |
552e3d24 |
712 | =back |
713 | |
714 | =head2 Informational predicates |
715 | |
a2e85e6c |
716 | These are all basic predicate methods for the values passed into C<new>. |
fe122940 |
717 | |
552e3d24 |
718 | =over 4 |
719 | |
720 | =item B<has_accessor> |
721 | |
552e3d24 |
722 | =item B<has_reader> |
723 | |
552e3d24 |
724 | =item B<has_writer> |
725 | |
c50c603e |
726 | =item B<has_predicate> |
727 | |
7d28758b |
728 | =item B<has_clearer> |
729 | |
0ab65f99 |
730 | =item B<has_initializer> |
731 | |
552e3d24 |
732 | =item B<has_init_arg> |
733 | |
552e3d24 |
734 | =item B<has_default> |
735 | |
bf731086 |
736 | =item B<has_builder> |
737 | |
552e3d24 |
738 | =back |
739 | |
9ec169fe |
740 | =head2 Class association |
741 | |
1d68af04 |
742 | These methods allow you to manage the attributes association with |
743 | the class that contains it. These methods should not be used |
2367814a |
744 | lightly, nor are they very magical, they are mostly used internally |
745 | and by metaclass instances. |
746 | |
9ec169fe |
747 | =over 4 |
748 | |
749 | =item B<associated_class> |
750 | |
2367814a |
751 | This returns the metaclass this attribute is associated with. |
752 | |
9ec169fe |
753 | =item B<attach_to_class ($class)> |
754 | |
1d68af04 |
755 | This will store a weaken reference to C<$class> internally. You should |
2367814a |
756 | note that just changing the class assocation will not remove the attribute |
757 | from it's old class, and initialize it (and it's accessors) in the new |
758 | C<$class>. It is up to you to do this manually. |
759 | |
9ec169fe |
760 | =item B<detach_from_class> |
761 | |
1d68af04 |
762 | This will remove the weakened reference to the class. It does B<not> |
763 | remove the attribute itself from the class (or remove it's accessors), |
764 | you must do that yourself if you want too. Actually if that is what |
765 | you want to do, you should probably be looking at |
2367814a |
766 | L<Class::MOP::Class::remove_attribute> instead. |
767 | |
9ec169fe |
768 | =back |
769 | |
552e3d24 |
770 | =head2 Attribute Accessor generation |
771 | |
772 | =over 4 |
773 | |
ba38bf08 |
774 | =item B<accessor_metaclass> |
775 | |
2367814a |
776 | Accessors are generated by an accessor metaclass, which is usually |
1d68af04 |
777 | a subclass of C<Class::MOP::Method::Accessor>. This method returns |
2367814a |
778 | the name of the accessor metaclass that this attribute uses. |
779 | |
780 | =item B<associate_method ($method)> |
781 | |
1d68af04 |
782 | This will associate a C<$method> with the given attribute which is |
783 | used internally by the accessor generator. |
3545c727 |
784 | |
785 | =item B<associated_methods> |
786 | |
1d68af04 |
787 | This will return the list of methods which have been associated with |
127d39a7 |
788 | the C<associate_method> methods. This is a good way of seeing what |
789 | methods are used to manage a given attribute. |
2367814a |
790 | |
9ec169fe |
791 | =item B<install_accessors> |
2eb717d5 |
792 | |
1d68af04 |
793 | This allows the attribute to generate and install code for it's own |
794 | I<accessor/reader/writer/predicate> methods. This is called by |
fe122940 |
795 | C<Class::MOP::Class::add_attribute>. |
2eb717d5 |
796 | |
1d68af04 |
797 | This method will call C<process_accessors> for each of the possible |
9ec169fe |
798 | method types (accessor, reader, writer & predicate). |
799 | |
800 | =item B<process_accessors ($type, $value)> |
801 | |
1d68af04 |
802 | This takes a C<$type> (accessor, reader, writer or predicate), and |
9ec169fe |
803 | a C<$value> (the value passed into the constructor for each of the |
1d68af04 |
804 | different types). It will then either generate the method itself |
805 | (using the C<generate_*_method> methods listed below) or it will |
806 | use the custom method passed through the constructor. |
9ec169fe |
807 | |
9ec169fe |
808 | =item B<remove_accessors> |
2eb717d5 |
809 | |
1d68af04 |
810 | This allows the attribute to remove the method for it's own |
811 | I<accessor/reader/writer/predicate/clearer>. This is called by |
fe122940 |
812 | C<Class::MOP::Class::remove_attribute>. |
2eb717d5 |
813 | |
1d68af04 |
814 | NOTE: This does not currently remove methods from the list returned |
2367814a |
815 | by C<associated_methods>, that is on the TODO list. |
816 | |
2eb717d5 |
817 | =back |
818 | |
819 | =head2 Introspection |
820 | |
821 | =over 4 |
552e3d24 |
822 | |
2eb717d5 |
823 | =item B<meta> |
552e3d24 |
824 | |
1d68af04 |
825 | This will return a B<Class::MOP::Class> instance which is related |
fe122940 |
826 | to this class. |
827 | |
1d68af04 |
828 | It should also be noted that B<Class::MOP> will actually bootstrap |
829 | this module by installing a number of attribute meta-objects into |
127d39a7 |
830 | it's metaclass. This will allow this class to reap all the benefits |
1d68af04 |
831 | of the MOP when subclassing it. |
fe122940 |
832 | |
552e3d24 |
833 | =back |
834 | |
1a09d9cc |
835 | =head1 AUTHORS |
8b978dd5 |
836 | |
a2e85e6c |
837 | Stevan Little E<lt>stevan@iinteractive.comE<gt> |
8b978dd5 |
838 | |
839 | =head1 COPYRIGHT AND LICENSE |
840 | |
69e3ab0a |
841 | Copyright 2006-2008 by Infinity Interactive, Inc. |
8b978dd5 |
842 | |
843 | L<http://www.iinteractive.com> |
844 | |
845 | This library is free software; you can redistribute it and/or modify |
1d68af04 |
846 | it under the same terms as Perl itself. |
8b978dd5 |
847 | |
16e960bd |
848 | =cut |
849 | |
7d28758b |
850 | |