Commit | Line | Data |
306290e8 |
1 | package Mouse::Meta::Attribute; |
bc69ee88 |
2 | use Mouse::Util qw(:meta); # enables strict and warnings |
c3398f5b |
3 | |
2efc0af1 |
4 | use Carp (); |
2efc0af1 |
5 | |
684db121 |
6 | use Mouse::Meta::TypeConstraint; |
d7d8d49b |
7 | |
87ca293b |
8 | sub _process_options{ |
9 | my($class, $name, $args) = @_; |
c3398f5b |
10 | |
04493075 |
11 | # XXX: for backward compatibility (with method modifiers) |
12 | if($class->can('canonicalize_args') != \&canonicalize_args){ |
13 | %{$args} = $class->canonicalize_args($name, %{$args}); |
14 | } |
15 | |
2efc0af1 |
16 | # taken from Class::MOP::Attribute::new |
17 | |
18 | defined($name) |
19 | or $class->throw_error('You must provide a name for the attribute'); |
2e7e86c6 |
20 | |
1b9e472d |
21 | if(!exists $args->{init_arg}){ |
22 | $args->{init_arg} = $name; |
2efc0af1 |
23 | } |
24 | |
25 | # 'required' requires eigher 'init_arg', 'builder', or 'default' |
1b9e472d |
26 | my $can_be_required = defined( $args->{init_arg} ); |
2efc0af1 |
27 | |
1b9e472d |
28 | if(exists $args->{builder}){ |
c6d8f5ca |
29 | # XXX: |
30 | # Moose refuses a CODE ref builder, but Mouse doesn't for backward compatibility |
31 | # This feature will be changed in a future. (gfx) |
121acb8a |
32 | $class->throw_error('builder must be a defined scalar value which is a method name') |
c6d8f5ca |
33 | #if ref $args->{builder} || !defined $args->{builder}; |
34 | if !defined $args->{builder}; |
2efc0af1 |
35 | |
36 | $can_be_required++; |
37 | } |
1b9e472d |
38 | elsif(exists $args->{default}){ |
39 | if(ref $args->{default} && ref($args->{default}) ne 'CODE'){ |
2efc0af1 |
40 | $class->throw_error("References are not allowed as default values, you must " |
41 | . "wrap the default of '$name' in a CODE reference (ex: sub { [] } and not [])"); |
42 | } |
43 | $can_be_required++; |
44 | } |
45 | |
1b9e472d |
46 | if( $args->{required} && !$can_be_required ) { |
121acb8a |
47 | $class->throw_error("You cannot have a required attribute ($name) without a default, builder, or an init_arg"); |
2efc0af1 |
48 | } |
49 | |
1b9e472d |
50 | # taken from Mouse::Meta::Attribute->new and _process_args-> |
2efc0af1 |
51 | |
1b9e472d |
52 | if(exists $args->{is}){ |
53 | my $is = $args->{is}; |
2efc0af1 |
54 | |
55 | if($is eq 'ro'){ |
1b9e472d |
56 | $args->{reader} ||= $name; |
2efc0af1 |
57 | } |
58 | elsif($is eq 'rw'){ |
1b9e472d |
59 | if(exists $args->{writer}){ |
60 | $args->{reader} ||= $name; |
2efc0af1 |
61 | } |
62 | else{ |
1b9e472d |
63 | $args->{accessor} ||= $name; |
2efc0af1 |
64 | } |
65 | } |
66 | elsif($is eq 'bare'){ |
67 | # do nothing, but don't complain (later) about missing methods |
68 | } |
69 | else{ |
70 | $is = 'undef' if !defined $is; |
71 | $class->throw_error("I do not understand this option (is => $is) on attribute ($name)"); |
72 | } |
73 | } |
74 | |
75 | my $tc; |
1b9e472d |
76 | if(exists $args->{isa}){ |
77 | $args->{type_constraint} = Mouse::Util::TypeConstraints::find_or_create_isa_type_constraint($args->{isa}); |
2efc0af1 |
78 | } |
1b9e472d |
79 | elsif(exists $args->{does}){ |
9f74c401 |
80 | $args->{type_constraint} = Mouse::Util::TypeConstraints::find_or_create_does_type_constraint($args->{does}); |
2efc0af1 |
81 | } |
1b9e472d |
82 | $tc = $args->{type_constraint}; |
2efc0af1 |
83 | |
1b9e472d |
84 | if($args->{coerce}){ |
2efc0af1 |
85 | defined($tc) |
86 | || $class->throw_error("You cannot have coercion without specifying a type constraint on attribute ($name)"); |
87 | |
1b9e472d |
88 | $args->{weak_ref} |
121acb8a |
89 | && $class->throw_error("You cannot have a weak reference to a coerced value on attribute ($name)"); |
2efc0af1 |
90 | } |
91 | |
1b9e472d |
92 | if ($args->{lazy_build}) { |
93 | exists($args->{default}) |
121acb8a |
94 | && $class->throw_error("You can not use lazy_build and default for the same attribute ($name)"); |
95 | |
1b9e472d |
96 | $args->{lazy} = 1; |
97 | $args->{builder} ||= "_build_${name}"; |
121acb8a |
98 | if ($name =~ /^_/) { |
1b9e472d |
99 | $args->{clearer} ||= "_clear${name}"; |
100 | $args->{predicate} ||= "_has${name}"; |
121acb8a |
101 | } |
102 | else { |
1b9e472d |
103 | $args->{clearer} ||= "clear_${name}"; |
104 | $args->{predicate} ||= "has_${name}"; |
121acb8a |
105 | } |
2efc0af1 |
106 | } |
107 | |
1b9e472d |
108 | if ($args->{auto_deref}) { |
121acb8a |
109 | defined($tc) |
110 | || $class->throw_error("You cannot auto-dereference without specifying a type constraint on attribute ($name)"); |
2efc0af1 |
111 | |
121acb8a |
112 | ( $tc->is_a_type_of('ArrayRef') || $tc->is_a_type_of('HashRef') ) |
113 | || $class->throw_error("You cannot auto-dereference anything other than a ArrayRef or HashRef on attribute ($name)"); |
2efc0af1 |
114 | } |
115 | |
1b9e472d |
116 | if (exists $args->{trigger}) { |
117 | ('CODE' eq ref $args->{trigger}) |
121acb8a |
118 | || $class->throw_error("Trigger must be a CODE ref on attribute ($name)"); |
2efc0af1 |
119 | } |
45959ffa |
120 | |
1b9e472d |
121 | if ($args->{lazy}) { |
122 | (exists $args->{default} || defined $args->{builder}) |
121acb8a |
123 | || $class->throw_error("You cannot have lazy attribute ($name) without specifying a default value for it"); |
2efc0af1 |
124 | } |
90fe520e |
125 | |
87ca293b |
126 | return; |
127 | } |
128 | |
129 | sub new { |
130 | my $class = shift; |
131 | my $name = shift; |
132 | |
133 | my %args = (@_ == 1) ? %{ $_[0] } : @_; |
134 | |
135 | $class->_process_options($name, \%args); |
136 | |
137 | $args{name} = $name; |
138 | |
926290ac |
139 | my $self = bless \%args, $class; |
2efc0af1 |
140 | |
1b9e472d |
141 | # extra attributes |
142 | if($class ne __PACKAGE__){ |
926290ac |
143 | $class->meta->_initialize_object($self, \%args); |
90fe520e |
144 | } |
c3398f5b |
145 | |
2efc0af1 |
146 | # XXX: there is no fast way to check attribute validity |
1b9e472d |
147 | # my @bad = ...; |
2efc0af1 |
148 | # if(@bad){ |
149 | # @bad = sort @bad; |
150 | # Carp::cluck("Found unknown argument(s) passed to '$name' attribute constructor in '$class': @bad"); |
151 | # } |
152 | |
926290ac |
153 | return $self; |
c3398f5b |
154 | } |
155 | |
43165725 |
156 | sub has_read_method { $_[0]->has_reader || $_[0]->has_accessor } |
157 | sub has_write_method { $_[0]->has_writer || $_[0]->has_accessor } |
1b9e472d |
158 | |
df77fd72 |
159 | sub _create_args { # DEPRECATED |
1bfebf5f |
160 | $_[0]->{_create_args} = $_[1] if @_ > 1; |
161 | $_[0]->{_create_args} |
162 | } |
163 | |
87ca293b |
164 | sub interpolate_class{ |
8cf51b82 |
165 | my($class, $args) = @_; |
c3398f5b |
166 | |
1b9e472d |
167 | if(my $metaclass = delete $args->{metaclass}){ |
168 | $class = Mouse::Util::resolve_metaclass_alias( Attribute => $metaclass ); |
169 | } |
1bfebf5f |
170 | |
87ca293b |
171 | my @traits; |
1b9e472d |
172 | if(my $traits_ref = delete $args->{traits}){ |
87ca293b |
173 | |
f3f04eed |
174 | for (my $i = 0; $i < @{$traits_ref}; $i++) { |
175 | my $trait = Mouse::Util::resolve_metaclass_alias(Attribute => $traits_ref->[$i], trait => 1); |
b2500191 |
176 | |
f3f04eed |
177 | next if $class->does($trait); |
74be9f76 |
178 | |
f3f04eed |
179 | push @traits, $trait; |
1b9e472d |
180 | |
f3f04eed |
181 | # are there options? |
182 | push @traits, $traits_ref->[++$i] |
183 | if ref($traits_ref->[$i+1]); |
184 | } |
c3398f5b |
185 | |
1b9e472d |
186 | if (@traits) { |
187 | $class = Mouse::Meta::Class->create_anon_class( |
188 | superclasses => [ $class ], |
189 | roles => \@traits, |
190 | cache => 1, |
191 | )->name; |
1b9e472d |
192 | } |
74be9f76 |
193 | } |
194 | |
87ca293b |
195 | return( $class, @traits ); |
1b9e472d |
196 | } |
197 | |
df77fd72 |
198 | sub canonicalize_args{ # DEPRECATED |
1b9e472d |
199 | my ($self, $name, %args) = @_; |
200 | |
201 | Carp::cluck("$self->canonicalize_args has been deprecated." |
04493075 |
202 | . "Use \$self->_process_options instead.") |
8aba926d |
203 | if Mouse::Util::_MOUSE_VERBOSE; |
1b9e472d |
204 | |
205 | return %args; |
206 | } |
207 | |
ce5920b7 |
208 | sub create { # DEPRECATED |
1b9e472d |
209 | my ($self, $class, $name, %args) = @_; |
210 | |
211 | Carp::cluck("$self->create has been deprecated." |
04493075 |
212 | . "Use \$meta->add_attribute and \$attr->install_accessors instead.") |
8aba926d |
213 | if Mouse::Util::_MOUSE_VERBOSE; |
1b9e472d |
214 | |
215 | # noop |
216 | return $self; |
c3398f5b |
217 | } |
218 | |
ffbbf459 |
219 | sub _coerce_and_verify { |
220 | my($self, $value, $instance) = @_; |
221 | |
222 | my $type_constraint = $self->{type_constraint}; |
4331a3f9 |
223 | return $value if !defined $type_constraint; |
ffbbf459 |
224 | |
225 | if ($self->should_coerce && $type_constraint->has_coercion) { |
226 | $value = $type_constraint->coerce($value); |
227 | } |
228 | |
ffbbf459 |
229 | $self->verify_against_type_constraint($value); |
230 | |
231 | return $value; |
232 | } |
233 | |
20e25eb9 |
234 | sub verify_against_type_constraint { |
f55f60dd |
235 | my ($self, $value) = @_; |
5aa30ced |
236 | |
ffbbf459 |
237 | my $type_constraint = $self->{type_constraint}; |
4331a3f9 |
238 | return 1 if !$type_constraint; |
ffbbf459 |
239 | return 1 if $type_constraint->check($value); |
5aa30ced |
240 | |
2a96ea85 |
241 | $self->verify_type_constraint_error($value, $type_constraint); |
b3b74cc6 |
242 | } |
5aa30ced |
243 | |
b3b74cc6 |
244 | sub verify_type_constraint_error { |
2a96ea85 |
245 | my($self, $value, $type) = @_; |
246 | |
247 | $self->throw_error( |
248 | sprintf q{Attribute (%s) does not pass the type constraint because: %s}, |
249 | $self->name, |
250 | $type->get_message($value), |
251 | ); |
5aa30ced |
252 | } |
253 | |
df77fd72 |
254 | sub coerce_constraint { # DEPRECATED |
8a7f2a8a |
255 | my $type = $_[0]->{type_constraint} |
256 | or return $_[1]; |
e763d56e |
257 | |
258 | Carp::cluck("coerce_constraint() has been deprecated, which was an internal utility anyway"); |
259 | |
7ca5c5fb |
260 | return Mouse::Util::TypeConstraints->typecast_constraints($_[0]->associated_class->name, $type, $_[1]); |
4188b837 |
261 | } |
262 | |
1b9e472d |
263 | sub clone_and_inherit_options{ |
8cf51b82 |
264 | my($self, %args) = @_; |
265 | |
266 | my($attribute_class, @traits) = ref($self)->interpolate_class(\%args); |
1b9e472d |
267 | |
8cf51b82 |
268 | $args{traits} = \@traits if @traits; |
4f41d79b |
269 | # do not inherit the 'handles' attribute |
270 | foreach my $name(keys %{$self}){ |
271 | if(!exists $args{$name} && $name ne 'handles'){ |
272 | $args{$name} = $self->{$name}; |
273 | } |
274 | } |
275 | return $attribute_class->new($self->name, %args); |
1b9e472d |
276 | } |
277 | |
df77fd72 |
278 | sub clone_parent { # DEPRECATED |
1bfebf5f |
279 | my $self = shift; |
280 | my $class = shift; |
281 | my $name = shift; |
282 | my %args = ($self->get_parent_args($class, $name), @_); |
283 | |
1b9e472d |
284 | Carp::cluck("$self->clone_parent has been deprecated." |
04493075 |
285 | . "Use \$meta->add_attribute and \$attr->install_accessors instead.") |
8aba926d |
286 | if Mouse::Util::_MOUSE_VERBOSE; |
1b9e472d |
287 | |
7ca5c5fb |
288 | $self->clone_and_inherited_args($class, $name, %args); |
1bfebf5f |
289 | } |
290 | |
df77fd72 |
291 | sub get_parent_args { # DEPRECATED |
1bfebf5f |
292 | my $self = shift; |
293 | my $class = shift; |
294 | my $name = shift; |
295 | |
724c77c0 |
296 | for my $super ($class->linearized_isa) { |
bb733405 |
297 | my $super_attr = $super->can("meta") && $super->meta->get_attribute($name) |
1bfebf5f |
298 | or next; |
299 | return %{ $super_attr->_create_args }; |
300 | } |
301 | |
fce211ae |
302 | $self->throw_error("Could not find an attribute by the name of '$name' to inherit from"); |
303 | } |
304 | |
2a464664 |
305 | |
0126c27c |
306 | sub get_read_method { |
751de1a1 |
307 | return $_[0]->reader || $_[0]->accessor |
df77fd72 |
308 | } |
0126c27c |
309 | sub get_write_method { |
751de1a1 |
310 | return $_[0]->writer || $_[0]->accessor |
311 | } |
312 | |
313 | sub _get_accessor_method_ref { |
314 | my($self, $type, $generator) = @_; |
315 | |
316 | my $metaclass = $self->associated_class |
317 | || $self->throw_error('No asocciated class for ' . $self->name); |
318 | |
319 | my $accessor = $self->$type(); |
320 | if($accessor){ |
321 | return $metaclass->get_method_body($accessor); |
322 | } |
323 | else{ |
324 | return $self->accessor_metaclass->$generator($self, $metaclass); |
325 | } |
df77fd72 |
326 | } |
2a464664 |
327 | |
328 | sub get_read_method_ref{ |
329 | my($self) = @_; |
751de1a1 |
330 | return $self->{_read_method_ref} ||= $self->_get_accessor_method_ref('get_read_method', '_generate_reader'); |
2a464664 |
331 | } |
332 | |
333 | sub get_write_method_ref{ |
334 | my($self) = @_; |
751de1a1 |
335 | return $self->{_write_method_ref} ||= $self->_get_accessor_method_ref('get_write_method', '_generate_writer'); |
336 | } |
2a464664 |
337 | |
751de1a1 |
338 | sub set_value { |
339 | my($self, $object, $value) = @_; |
340 | return $self->get_write_method_ref()->($object, $value); |
341 | } |
342 | |
343 | sub get_value { |
344 | my($self, $object) = @_; |
345 | return $self->get_read_method_ref()->($object); |
2a464664 |
346 | } |
347 | |
751de1a1 |
348 | sub has_value { |
349 | my($self, $object) = @_; |
060f9228 |
350 | my $accessor_ref = $self->{_predicate_ref} |
751de1a1 |
351 | ||= $self->_get_accessor_method_ref('predicate', '_generate_predicate'); |
352 | |
060f9228 |
353 | return $accessor_ref->($object); |
751de1a1 |
354 | } |
355 | |
356 | sub clear_value { |
357 | my($self, $object) = @_; |
060f9228 |
358 | my $accessor_ref = $self->{_crealer_ref} |
751de1a1 |
359 | ||= $self->_get_accessor_method_ref('clearer', '_generate_clearer'); |
360 | |
060f9228 |
361 | return $accessor_ref->($object); |
751de1a1 |
362 | } |
363 | |
364 | |
04493075 |
365 | sub associate_method{ |
e5e22afd |
366 | my ($attribute, $method_name) = @_; |
04493075 |
367 | $attribute->{associated_methods}++; |
368 | return; |
369 | } |
370 | |
1b9e472d |
371 | sub install_accessors{ |
372 | my($attribute) = @_; |
373 | |
93540011 |
374 | my $metaclass = $attribute->associated_class; |
4ab51fb0 |
375 | my $accessor_class = $attribute->accessor_metaclass; |
1b9e472d |
376 | |
4ab51fb0 |
377 | foreach my $type(qw(accessor reader writer predicate clearer)){ |
1b9e472d |
378 | if(exists $attribute->{$type}){ |
4ab51fb0 |
379 | my $generator = '_generate_' . $type; |
380 | my $code = $accessor_class->$generator($attribute, $metaclass); |
381 | $metaclass->add_method($attribute->{$type} => $code); |
e5e22afd |
382 | $attribute->associate_method($attribute->{$type}); |
4ab51fb0 |
383 | } |
384 | } |
7ca5c5fb |
385 | |
4ab51fb0 |
386 | # install delegation |
387 | if(exists $attribute->{handles}){ |
388 | my %handles = $attribute->_canonicalize_handles($attribute->{handles}); |
feaa7084 |
389 | |
cbb81058 |
390 | while(my($handle, $method_to_call) = each %handles){ |
391 | $metaclass->add_method($handle => |
392 | $attribute->_make_delegation_method( |
393 | $handle, $method_to_call)); |
4ab51fb0 |
394 | |
cbb81058 |
395 | $attribute->associate_method($handle); |
1b9e472d |
396 | } |
397 | } |
398 | |
399 | if($attribute->can('create') != \&create){ |
7ca5c5fb |
400 | # backword compatibility |
1b9e472d |
401 | $attribute->create($metaclass, $attribute->name, %{$attribute}); |
402 | } |
403 | |
404 | return; |
405 | } |
406 | |
cbb81058 |
407 | sub delegation_metaclass() { 'Mouse::Meta::Method::Delegation' } |
408 | |
409 | sub _canonicalize_handles { |
410 | my($self, $handles) = @_; |
411 | |
412 | if (ref($handles) eq 'HASH') { |
413 | return %$handles; |
414 | } |
415 | elsif (ref($handles) eq 'ARRAY') { |
416 | return map { $_ => $_ } @$handles; |
417 | } |
418 | elsif (ref($handles) eq 'Regexp') { |
419 | my $class_or_role = ($self->{isa} || $self->{does}) |
420 | || $self->throw_error("Cannot delegate methods based on a Regexp without a type constraint (isa)"); |
421 | |
422 | my $meta = Mouse::Meta::Class->initialize("$class_or_role"); # "" for stringify |
423 | return map { $_ => $_ } |
424 | grep { !Mouse::Object->can($_) && $_ =~ $handles } |
425 | Mouse::Util::is_a_metarole($meta) |
426 | ? $meta->get_method_list |
427 | : $meta->get_all_method_names; |
428 | } |
429 | else { |
430 | $self->throw_error("Unable to canonicalize the 'handles' option with $handles"); |
431 | } |
432 | } |
433 | |
434 | sub _make_delegation_method { |
435 | my($self, $handle, $method_to_call) = @_; |
436 | my $delegator = $self->delegation_metaclass; |
437 | Mouse::Util::load_class($delegator); |
438 | |
439 | return $delegator->_generate_delegation($self, $handle, $method_to_call); |
440 | } |
441 | |
fce211ae |
442 | sub throw_error{ |
443 | my $self = shift; |
444 | |
445 | my $metaclass = (ref $self && $self->associated_class) || 'Mouse::Meta::Class'; |
446 | $metaclass->throw_error(@_, depth => 1); |
1bfebf5f |
447 | } |
448 | |
c3398f5b |
449 | 1; |
c3398f5b |
450 | __END__ |
451 | |
452 | =head1 NAME |
453 | |
bedd575c |
454 | Mouse::Meta::Attribute - The Mouse attribute metaclass |
c3398f5b |
455 | |
a25ca8d6 |
456 | =head1 VERSION |
457 | |
a4cbb3cb |
458 | This document describes Mouse version 0.44 |
a25ca8d6 |
459 | |
c3398f5b |
460 | =head1 METHODS |
461 | |
1820fffe |
462 | =head2 C<< new(%options) -> Mouse::Meta::Attribute >> |
c3398f5b |
463 | |
306290e8 |
464 | Instantiates a new Mouse::Meta::Attribute. Does nothing else. |
c3398f5b |
465 | |
1820fffe |
466 | It adds the following options to the constructor: |
c3398f5b |
467 | |
1820fffe |
468 | =over 4 |
c3398f5b |
469 | |
612d3e1a |
470 | =item C<< is => 'ro', 'rw', 'bare' >> |
c3398f5b |
471 | |
1820fffe |
472 | This provides a shorthand for specifying the C<reader>, C<writer>, or |
473 | C<accessor> names. If the attribute is read-only ('ro') then it will |
474 | have a C<reader> method with the same attribute as the name. |
c3398f5b |
475 | |
1820fffe |
476 | If it is read-write ('rw') then it will have an C<accessor> method |
477 | with the same name. If you provide an explicit C<writer> for a |
478 | read-write attribute, then you will have a C<reader> with the same |
479 | name as the attribute, and a C<writer> with the name you provided. |
c3398f5b |
480 | |
1820fffe |
481 | Use 'bare' when you are deliberately not installing any methods |
482 | (accessor, reader, etc.) associated with this attribute; otherwise, |
483 | Moose will issue a deprecation warning when this attribute is added to a |
484 | metaclass. |
c3398f5b |
485 | |
612d3e1a |
486 | =item C<< isa => Type >> |
ab27a55e |
487 | |
1820fffe |
488 | This option accepts a type. The type can be a string, which should be |
489 | a type name. If the type name is unknown, it is assumed to be a class |
490 | name. |
ab27a55e |
491 | |
1820fffe |
492 | This option can also accept a L<Moose::Meta::TypeConstraint> object. |
ab27a55e |
493 | |
1820fffe |
494 | If you I<also> provide a C<does> option, then your C<isa> option must |
495 | be a class name, and that class must do the role specified with |
496 | C<does>. |
ab27a55e |
497 | |
612d3e1a |
498 | =item C<< does => Role >> |
ab27a55e |
499 | |
1820fffe |
500 | This is short-hand for saying that the attribute's type must be an |
501 | object which does the named role. |
c3398f5b |
502 | |
1820fffe |
503 | B<This option is not yet supported.> |
c3398f5b |
504 | |
612d3e1a |
505 | =item C<< coerce => Bool >> |
ab27a55e |
506 | |
1820fffe |
507 | This option is only valid for objects with a type constraint |
508 | (C<isa>). If this is true, then coercions will be applied whenever |
509 | this attribute is set. |
c3398f5b |
510 | |
1820fffe |
511 | You can make both this and the C<weak_ref> option true. |
c3398f5b |
512 | |
612d3e1a |
513 | =item C<< trigger => CodeRef >> |
ab27a55e |
514 | |
1820fffe |
515 | This option accepts a subroutine reference, which will be called after |
516 | the attribute is set. |
ab27a55e |
517 | |
612d3e1a |
518 | =item C<< required => Bool >> |
ab27a55e |
519 | |
1820fffe |
520 | An attribute which is required must be provided to the constructor. An |
521 | attribute which is required can also have a C<default> or C<builder>, |
522 | which will satisfy its required-ness. |
ab27a55e |
523 | |
1820fffe |
524 | A required attribute must have a C<default>, C<builder> or a |
525 | non-C<undef> C<init_arg> |
ab27a55e |
526 | |
612d3e1a |
527 | =item C<< lazy => Bool >> |
ab27a55e |
528 | |
1820fffe |
529 | A lazy attribute must have a C<default> or C<builder>. When an |
530 | attribute is lazy, the default value will not be calculated until the |
531 | attribute is read. |
93f08899 |
532 | |
612d3e1a |
533 | =item C<< weak_ref => Bool >> |
0fff36e6 |
534 | |
1820fffe |
535 | If this is true, the attribute's value will be stored as a weak |
536 | reference. |
c3398f5b |
537 | |
612d3e1a |
538 | =item C<< auto_deref => Bool >> |
fb706f5c |
539 | |
1820fffe |
540 | If this is true, then the reader will dereference the value when it is |
541 | called. The attribute must have a type constraint which defines the |
542 | attribute as an array or hash reference. |
543 | |
612d3e1a |
544 | =item C<< lazy_build => Bool >> |
1820fffe |
545 | |
546 | Setting this to true makes the attribute lazy and provides a number of |
547 | default methods. |
fb706f5c |
548 | |
1820fffe |
549 | has 'size' => ( |
550 | is => 'ro', |
551 | lazy_build => 1, |
552 | ); |
93d190e0 |
553 | |
1820fffe |
554 | is equivalent to this: |
93d190e0 |
555 | |
1820fffe |
556 | has 'size' => ( |
557 | is => 'ro', |
558 | lazy => 1, |
559 | builder => '_build_size', |
560 | clearer => 'clear_size', |
561 | predicate => 'has_size', |
562 | ); |
93d190e0 |
563 | |
1820fffe |
564 | =back |
565 | |
e5e22afd |
566 | =head2 C<< associate_method(MethodName) >> |
31c5194b |
567 | |
568 | Associates a method with the attribute. Typically, this is called internally |
569 | when an attribute generates its accessors. |
570 | |
e5e22afd |
571 | Currently the argument I<MethodName> is ignored in Mouse. |
31c5194b |
572 | |
1820fffe |
573 | =head2 C<< verify_against_type_constraint(Item) -> TRUE | ERROR >> |
574 | |
575 | Checks that the given value passes this attribute's type constraint. Returns C<true> |
576 | on success, otherwise C<confess>es. |
93d190e0 |
577 | |
1820fffe |
578 | =head2 C<< clone_and_inherit_options(options) -> Mouse::Meta::Attribute >> |
f7b11a21 |
579 | |
612d3e1a |
580 | Creates a new attribute in the owner class, inheriting options from parent classes. |
f7b11a21 |
581 | Accessors and helper methods are installed. Some error checking is done. |
582 | |
9ae9702e |
583 | =head2 C<< get_read_method_ref >> |
584 | |
585 | =head2 C<< get_write_method_ref >> |
586 | |
587 | Returns the subroutine reference of a method suitable for reading or |
588 | writing the attribute's value in the associated class. These methods |
589 | always return a subroutine reference, regardless of whether or not the |
df77fd72 |
590 | attribute is read- or write-only. |
591 | |
1820fffe |
592 | =head1 SEE ALSO |
f7b11a21 |
593 | |
1820fffe |
594 | L<Moose::Meta::Attribute> |
f7b11a21 |
595 | |
31c5194b |
596 | L<Class::MOP::Attribute> |
597 | |
c3398f5b |
598 | =cut |
599 | |