X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FAccessorGroup.pm;h=12a8744b2042594794608711532fc6179552b0f8;hb=d009cb7d393292037eff527a9f8bab93860224fb;hp=56bcf1bb85649c3398d0b7ee6df6fde50660719a;hpb=96a3c685e86416445cbd59dc2309e102f52b9c87;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/AccessorGroup.pm b/lib/DBIx/Class/AccessorGroup.pm index 56bcf1b..12a8744 100644 --- a/lib/DBIx/Class/AccessorGroup.pm +++ b/lib/DBIx/Class/AccessorGroup.pm @@ -3,340 +3,68 @@ package DBIx::Class::AccessorGroup; use strict; use warnings; -use Carp::Clan qw/^DBIx::Class/; +use base qw/Class::Accessor::Grouped/; +use Scalar::Util qw/weaken blessed/; +use namespace::clean; -=head1 NAME - -DBIx::Class::AccessorGroup - Lets you build groups of accessors - -=head1 SYNOPSIS - -=head1 DESCRIPTION - -This class lets you build groups of accessors that will call different -getters and setters. - -=head1 METHODS - -=head2 mk_group_accessors - -=over 4 - -=item Arguments: $group, @fieldspec - -Returns: none - -=back - -Creates a set of accessors in a given group. - -$group is the name of the accessor group for the generated accessors; they -will call get_$group($field) on get and set_$group($field, $value) on set. - -@fieldspec is a list of field/accessor names; if a fieldspec is a scalar -this is used as both field and accessor name, if a listref it is expected to -be of the form [ $accessor, $field ]. - -=cut - -sub mk_group_accessors { - my ($self, $group, @fields) = @_; - - $self->_mk_group_accessors('make_group_accessor', $group, @fields); - return; +sub mk_classdata { + shift->mk_classaccessor(@_); } - -{ - no strict 'refs'; - no warnings 'redefine'; - - sub _mk_group_accessors { - my($self, $maker, $group, @fields) = @_; - my $class = ref $self || $self; - - # So we don't have to do lots of lookups inside the loop. - $maker = $self->can($maker) unless ref $maker; - - foreach my $field (@fields) { - if( $field eq 'DESTROY' ) { - carp("Having a data accessor named DESTROY in ". - "'$class' is unwise."); - } - - my $name = $field; - - ($name, $field) = @$field if ref $field; - - my $accessor = $self->$maker($group, $field); - my $alias = "_${name}_accessor"; - - #warn "$class $group $field $alias"; - - *{$class."\:\:$name"} = $accessor; - #unless defined &{$class."\:\:$field"} - - *{$class."\:\:$alias"} = $accessor; - #unless defined &{$class."\:\:$alias"} - } - } +sub mk_classaccessor { + my $self = shift; + $self->mk_group_accessors('inherited', $_[0]); + $self->set_inherited(@_) if @_ > 1; } -=head2 mk_group_ro_accessors - -=over 4 - -=item Arguments: $group, @fieldspec - -Returns: none - -=back - -Creates a set of read only accessors in a given group. Identical to - but accessors will throw an error if passed a value -rather than setting the value. - -=cut - -sub mk_group_ro_accessors { - my($self, $group, @fields) = @_; - - $self->_mk_group_accessors('make_group_ro_accessor', $group, @fields); -} - -=head2 mk_group_wo_accessors - -=over 4 - -=item Arguments: $group, @fieldspec - -Returns: none - -=back - -Creates a set of write only accessors in a given group. Identical to - but accessors will throw an error if not passed a -value rather than getting the value. - -=cut - -sub mk_group_wo_accessors { - my($self, $group, @fields) = @_; - - $self->_mk_group_accessors('make_group_wo_accessor', $group, @fields); -} - -=head2 make_group_accessor - -=over 4 - -=item Arguments: $group, $field - -Returns: $sub (\CODE) - -=back - -Returns a single accessor in a given group; called by mk_group_accessors -for each entry in @fieldspec. - -=cut - -sub make_group_accessor { - my ($class, $group, $field) = @_; - - my $set = "set_$group"; - my $get = "get_$group"; - - # Build a closure around $field. - return sub { - my $self = shift; - - if(@_) { - return $self->$set($field, @_); - } - else { - return $self->$get($field); - } - }; -} - -=head2 make_group_ro_accessor - -=over 4 +my $successfully_loaded_components; -=item Arguments: $group, $field - -Returns: $sub (\CODE) - -=back - -Returns a single read-only accessor in a given group; called by -mk_group_ro_accessors for each entry in @fieldspec. - -=cut - -sub make_group_ro_accessor { - my($class, $group, $field) = @_; - - my $get = "get_$group"; - - return sub { - my $self = shift; - - if(@_) { - my $caller = caller; - croak("'$caller' cannot alter the value of '$field' on ". - "objects of class '$class'"); - } - else { - return $self->$get($field); - } - }; -} - -=head2 make_group_wo_accessor - -=over 4 - -=item Arguments: $group, $field - -Returns: $sub (\CODE) - -=back - -Returns a single write-only accessor in a given group; called by -mk_group_wo_accessors for each entry in @fieldspec. - -=cut - -sub make_group_wo_accessor { - my($class, $group, $field) = @_; - - my $set = "set_$group"; - - return sub { - my $self = shift; - - unless (@_) { - my $caller = caller; - croak("'$caller' cannot access the value of '$field' on ". - "objects of class '$class'"); - } - else { - return $self->$set($field, @_); - } - }; -} - -=head2 get_simple - -=over 4 - -=item Arguments: $field - -Returns: $value - -=back - -Simple getter for hash-based objects which returns the value for the field -name passed as an argument. - -=cut - -sub get_simple { - my ($self, $get) = @_; - return $self->{$get}; -} - -=head2 set_simple - -=over 4 - -=item Arguments: $field, $new_value - -Returns: $new_value - -=back - -Simple setter for hash-based objects which sets and then returns the value -for the field name passed as an argument. - -=cut - -sub set_simple { - my ($self, $set, $val) = @_; - return $self->{$set} = $val; -} - -=head2 get_component_class - -=over 4 - -=item Arguments: $name - -Returns: $component_class +sub get_component_class { + my $class = $_[0]->get_inherited($_[1]); -=back + # It's already an object, just go for it. + return $class if blessed $class; -Returns the class name for a component; returns an object key if called on -an object, or attempts to return classdata referenced by _$name if called -on a class. + if (defined $class and ! $successfully_loaded_components->{$class} ) { + $_[0]->ensure_class_loaded($class); -=cut + mro::set_mro( $class, 'c3' ); -sub get_component_class { - my ($self, $get) = @_; - if (ref $self) { - return $self->{$get}; - } else { - $get = "_$get"; - return $self->can($get) ? $self->$get : undef; + no strict 'refs'; + $successfully_loaded_components->{$class} + = ${"${class}::__LOADED__BY__DBIC__CAG__COMPONENT_CLASS__"} + = do { \(my $anon = 'loaded') }; + weaken($successfully_loaded_components->{$class}); } -} -=head2 set_component_class + $class; +}; -=over 4 - -=item Arguments: $name, $new_component_class +sub set_component_class { + shift->set_inherited(@_); +} -Returns: $new_component_class +1; -=back +=head1 NAME -Sets a component class name; attempts to require the class before setting -but does not error if unable to do so. Sets an object key of the given name -if called or an object or classdata called _$name if called on a class. +DBIx::Class::AccessorGroup - See Class::Accessor::Grouped -=cut +=head1 SYNOPSIS -sub set_component_class { - my ($self, $set, $val) = @_; - eval "require $val"; - if ($@) { - my $val_path = $val; - $val_path =~ s{::}{/}g; - carp $@ unless $@ =~ /^Can't locate $val_path\.pm/; - } - if (ref $self) { - return $self->{$set} = $val; - } else { - $set = "_$set"; - return $self->can($set) ? - $self->$set($val) : - $self->mk_classdata($set => $val); - } -} +=head1 DESCRIPTION -1; +This class now exists in its own right on CPAN as Class::Accessor::Grouped -=head1 AUTHORS +=head1 FURTHER QUESTIONS? -Matt S. Trout +Check the list of L. -=head1 LICENSE +=head1 COPYRIGHT AND LICENSE -You may distribute this code under the same terms as Perl itself. +This module is free software L +by the L. You can +redistribute it and/or modify it under the same terms as the +L. =cut -