2 package Class::MOP::Method::Accessor;
8 use Scalar::Util 'blessed', 'weaken';
11 our $VERSION = '1.11';
12 $VERSION = eval $VERSION;
13 our $AUTHORITY = 'cpan:STEVAN';
15 use base 'Class::MOP::Method::Generated';
21 (exists $options{attribute})
22 || confess "You must supply an attribute to construct with";
24 (exists $options{accessor_type})
25 || confess "You must supply an accessor_type to construct with";
27 (blessed($options{attribute}) && $options{attribute}->isa('Class::MOP::Attribute'))
28 || confess "You must supply an attribute which is a 'Class::MOP::Attribute' instance";
30 ($options{package_name} && $options{name})
31 || confess "You must supply the package_name and name parameters $Class::MOP::Method::UPGRADE_ERROR_TEXT";
33 my $self = $class->_new(\%options);
35 # we don't want this creating
36 # a cycle in the code, if not
38 weaken($self->{'attribute'});
40 $self->_initialize_body;
48 return Class::MOP::Class->initialize($class)->new_object(@_)
49 if $class ne __PACKAGE__;
51 my $params = @_ == 1 ? $_[0] : {@_};
54 # inherited from Class::MOP::Method
55 body => $params->{body},
56 associated_metaclass => $params->{associated_metaclass},
57 package_name => $params->{package_name},
58 name => $params->{name},
59 original_method => $params->{original_method},
61 # inherit from Class::MOP::Generated
62 is_inline => $params->{is_inline} || 0,
63 definition_context => $params->{definition_context},
65 # defined in this class
66 attribute => $params->{attribute},
67 accessor_type => $params->{accessor_type},
73 sub associated_attribute { (shift)->{'attribute'} }
74 sub accessor_type { (shift)->{'accessor_type'} }
78 sub _initialize_body {
81 my $method_name = join "_" => (
85 ($self->is_inline ? 'inline' : ())
88 $self->{'body'} = $self->$method_name();
93 sub _generate_accessor_method {
95 my $attr = $self->associated_attribute;
99 $attr->set_value($_[0], $_[1]);
101 $attr->get_value($_[0]);
105 sub _generate_accessor_method_inline {
107 my $attr = $self->associated_attribute;
110 $self->_compile_code([
113 $attr->_inline_set_value('$_[0]', '$_[1]'),
115 $attr->_inline_get_value('$_[0]'),
120 confess "Could not generate inline accessor because : $_";
124 sub _generate_reader_method {
126 my $attr = $self->associated_attribute;
129 confess "Cannot assign a value to a read-only accessor"
131 $attr->get_value($_[0]);
135 sub _generate_reader_method_inline {
137 my $attr = $self->associated_attribute;
140 $self->_compile_code([
142 'confess "Cannot assign a value to a read-only accessor"',
144 $attr->_inline_get_value('$_[0]'),
149 confess "Could not generate inline reader because : $_";
153 sub _generate_writer_method {
155 my $attr = $self->associated_attribute;
158 $attr->set_value($_[0], $_[1]);
162 sub _generate_writer_method_inline {
164 my $attr = $self->associated_attribute;
167 $self->_compile_code([
169 $attr->_inline_set_value('$_[0]', '$_[1]'),
174 confess "Could not generate inline writer because : $_";
178 sub _generate_predicate_method {
180 my $attr = $self->associated_attribute;
183 $attr->has_value($_[0])
187 sub _generate_predicate_method_inline {
189 my $attr = $self->associated_attribute;
192 $self->_compile_code([
194 $attr->_inline_has_value('$_[0]'),
199 confess "Could not generate inline predicate because : $_";
203 sub _generate_clearer_method {
205 my $attr = $self->associated_attribute;
208 $attr->clear_value($_[0])
212 sub _generate_clearer_method_inline {
214 my $attr = $self->associated_attribute;
217 $self->_compile_code([
219 $attr->_inline_clear_value('$_[0]'),
224 confess "Could not generate inline clearer because : $_";
236 Class::MOP::Method::Accessor - Method Meta Object for accessors
240 use Class::MOP::Method::Accessor;
242 my $reader = Class::MOP::Method::Accessor->new(
243 attribute => $attribute,
245 accessor_type => 'reader',
248 $reader->body->execute($instance); # call the reader method
252 This is a subclass of C<Class::MOP::Method> which is used by
253 C<Class::MOP::Attribute> to generate accessor code. It handles
254 generation of readers, writers, predicates and clearers. For each type
255 of method, it can either create a subroutine reference, or actually
256 inline code by generating a string and C<eval>'ing it.
262 =item B<< Class::MOP::Method::Accessor->new(%options) >>
264 This returns a new C<Class::MOP::Method::Accessor> based on the
265 C<%options> provided.
271 This is the C<Class::MOP::Attribute> for which accessors are being
272 generated. This option is required.
274 =item * accessor_type
276 This is a string which should be one of "reader", "writer",
277 "accessor", "predicate", or "clearer". This is the type of method
278 being generated. This option is required.
282 This indicates whether or not the accessor should be inlined. This
287 The method name (without a package name). This is required.
291 The package name for the method. This is required.
295 =item B<< $metamethod->accessor_type >>
297 Returns the accessor type which was passed to C<new>.
299 =item B<< $metamethod->is_inline >>
301 Returns a boolean indicating whether or not the accessor is inlined.
303 =item B<< $metamethod->associated_attribute >>
305 This returns the L<Class::MOP::Attribute> object which was passed to
308 =item B<< $metamethod->body >>
310 The method itself is I<generated> when the accessor object is
317 Stevan Little E<lt>stevan@iinteractive.comE<gt>
319 =head1 COPYRIGHT AND LICENSE
321 Copyright 2006-2010 by Infinity Interactive, Inc.
323 L<http://www.iinteractive.com>
325 This library is free software; you can redistribute it and/or modify
326 it under the same terms as Perl itself.