restore mk_classaccessor
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class.pm
index a6c290d..42742f2 100644 (file)
@@ -4,41 +4,51 @@ use strict;
 use warnings;
 
 use vars qw($VERSION);
-use base qw/DBIx::Class::Componentised Class::Data::Accessor/;
+use base qw/DBIx::Class::Componentised Class::Accessor::Grouped/;
+
+
+sub mk_classdata { 
+  shift->mk_classaccessor(@_);
+}
+
+sub mk_classaccessor {
+  my $self = shift;
+  $self->mk_group_accessors('inherited', $_[0]); 
+  $self->set_inherited(@_) if @_ > 1;
+}
 
-sub mk_classdata { shift->mk_classaccessor(@_); }
 sub component_base_class { 'DBIx::Class' }
 
 # Always remember to do all digits for the version even if they're 0
 # i.e. first release of 0.XX *must* be 0.XX000. This avoids fBSD ports
 # brain damage and presumably various other packaging systems too
 
-$VERSION = '0.05999_04';
+$VERSION = '0.08002';
 
 sub MODIFY_CODE_ATTRIBUTES {
-    my ($class,$code,@attrs) = @_;
-    $class->mk_classdata('__attr_cache' => {})
-      unless $class->can('__attr_cache');
-    $class->__attr_cache->{$code} = [@attrs];
-    return ();
+  my ($class,$code,@attrs) = @_;
+  $class->mk_classdata('__attr_cache' => {})
+    unless $class->can('__attr_cache');
+  $class->__attr_cache->{$code} = [@attrs];
+  return ();
 }
 
 sub _attr_cache {
-    my $self = shift;
-    my $cache = $self->can('__attr_cache') ? $self->__attr_cache : {};
-    my $rest = eval { $self->next::method };
-    return $@ ? $cache : { %$cache, %$rest };
+  my $self = shift;
+  my $cache = $self->can('__attr_cache') ? $self->__attr_cache : {};
+  my $rest = eval { $self->next::method };
+  return $@ ? $cache : { %$cache, %$rest };
 }
 
 1;
 
-=head1 NAME 
+=head1 NAME
 
 DBIx::Class - Extensible and flexible object <-> relational mapper.
 
 =head1 SYNOPSIS
 
-Create a base schema class called DB/Main.pm:
+Create a schema class called DB/Main.pm:
 
   package DB::Main;
   use base qw/DBIx::Class::Schema/;
@@ -47,7 +57,7 @@ Create a base schema class called DB/Main.pm:
 
   1;
 
-Create a class that represent artists, who have many CDs, in DB/Main/Artist.pm:
+Create a table class to represent artists, who have many CDs, in DB/Main/Artist.pm:
 
   package DB::Main::Artist;
   use base qw/DBIx::Class/;
@@ -56,52 +66,56 @@ Create a class that represent artists, who have many CDs, in DB/Main/Artist.pm:
   __PACKAGE__->table('artist');
   __PACKAGE__->add_columns(qw/ artistid name /);
   __PACKAGE__->set_primary_key('artistid');
-  __PACKAGE__->has_many('cds' => 'DB::Main::CD');
+  __PACKAGE__->has_many(cds => 'DB::Main::CD');
 
   1;
 
-A class to represent a CD, which belongs to an artist, in DB/Main/CD.pm:
+A table class to represent a CD, which belongs to an artist, in DB/Main/CD.pm:
 
   package DB::Main::CD;
   use base qw/DBIx::Class/;
 
   __PACKAGE__->load_components(qw/PK::Auto Core/);
   __PACKAGE__->table('cd');
-  __PACKAGE__->add_columns(qw/ cdid artist title year/);
+  __PACKAGE__->add_columns(qw/ cdid artist title year /);
   __PACKAGE__->set_primary_key('cdid');
-  __PACKAGE__->belongs_to('artist' => 'DB::Main::Artist');
+  __PACKAGE__->belongs_to(artist => 'DB::Main::Artist');
 
   1;
 
 Then you can use these classes in your application's code:
 
   # Connect to your database.
-  my $ds = DB::Main->connect(@dbi_dsn);
+  use DB::Main;
+  my $schema = DB::Main->connect($dbi_dsn, $user, $pass, \%dbi_params);
 
   # Query for all artists and put them in an array,
   # or retrieve them as a result set object.
-  my @all_artists = $ds->resultset('Artist')->all;
-  my $all_artists_rs = $ds->resultset('Artist');
+  my @all_artists = $schema->resultset('Artist')->all;
+  my $all_artists_rs = $schema->resultset('Artist');
 
   # Create a result set to search for artists.
   # This does not query the DB.
-  my $johns_rs = $ds->resultset('Artist')->search(
+  my $johns_rs = $schema->resultset('Artist')->search(
     # Build your WHERE using an SQL::Abstract structure:
-    { 'name' => { 'like', 'John%' } }
+    { name => { like => 'John%' } }
   );
 
-  # This executes a joined query to get the cds
+  # Execute a joined query to get the cds.
   my @all_john_cds = $johns_rs->search_related('cds')->all;
 
-  # Queries but only fetches one row so far.
+  # Fetch only the next row.
   my $first_john = $johns_rs->next;
 
+  # Specify ORDER BY on the query.
   my $first_john_cds_by_title_rs = $first_john->cds(
     undef,
     { order_by => 'title' }
   );
 
-  my $millennium_cds_rs = $ds->resultset('CD')->search(
+  # Create a result set that will fetch the artist relationship
+  # at the same time as it fetches CDs, using only one query.
+  my $millennium_cds_rs = $schema->resultset('CD')->search(
     { year => 2000 },
     { prefetch => 'artist' }
   );
@@ -109,12 +123,12 @@ Then you can use these classes in your application's code:
   my $cd = $millennium_cds_rs->next; # SELECT ... FROM cds JOIN artists ...
   my $cd_artist_name = $cd->artist->name; # Already has the data so no query
 
-  my $new_cd = $ds->resultset('CD')->new({ title => 'Spoon' });
+  my $new_cd = $schema->resultset('CD')->new({ title => 'Spoon' });
   $new_cd->artist($cd->artist);
   $new_cd->insert; # Auto-increment primary key filled in after INSERT
   $new_cd->title('Fork');
 
-  $ds->txn_do(sub { $new_cd->update }); # Runs the update in a transaction
+  $schema->txn_do(sub { $new_cd->update }); # Runs the update in a transaction
 
   $millennium_cds_rs->update({ year => 2002 }); # Single-query bulk update
 
@@ -130,27 +144,26 @@ JOIN, LEFT JOIN, COUNT, DISTINCT, GROUP BY and HAVING support.
 
 DBIx::Class can handle multi-column primary and foreign keys, complex
 queries and database-level paging, and does its best to only query the
-database when it actually needs to in order to return something you've directly
-asked for. If a resultset is used as an iterator it only fetches rows off
-the statement handle as requested in order to minimise memory usage. It
-has auto-increment support for SQLite, MySQL, PostgreSQL, Oracle, SQL
-Server and DB2 and is known to be used in production on at least the first
-four, and is fork- and thread-safe out of the box (although your DBD may not
-be). 
+database in order to return something you've directly asked for. If a
+resultset is used as an iterator it only fetches rows off the statement
+handle as requested in order to minimise memory usage. It has auto-increment
+support for SQLite, MySQL, PostgreSQL, Oracle, SQL Server and DB2 and is
+known to be used in production on at least the first four, and is fork-
+and thread-safe out of the box (although your DBD may not be).
 
 This project is still under rapid development, so features added in the
-latest major release may not work 100% yet - check the Changes if you run
+latest major release may not work 100% yet -- check the Changes if you run
 into trouble, and beware of anything explicitly marked EXPERIMENTAL. Failing
 test cases are *always* welcome and point releases are put out rapidly as
 bugs are found and fixed.
 
 Even so, we do our best to maintain full backwards compatibility for published
-APIs since DBIx::Class is used in production in a number of organisations;
-the test suite is now fairly substantial and several developer releases are
+APIs, since DBIx::Class is used in production in a number of organisations.
+The test suite is quite substantial, and several developer releases are
 generally made to CPAN before the -current branch is merged back to trunk for
 a major release.
 
-The community can be found via -
+The community can be found via:
 
   Mailing list: http://lists.rawmode.org/mailman/listinfo/dbix-class/
 
@@ -162,27 +175,8 @@ The community can be found via -
 
 =head1 WHERE TO GO NEXT
 
-=over 4
-
-=item L<DBIx::Class::Manual> - user's manual
-
-=item L<DBIx::Class::Core> - DBIC Core Classes
-
-=item L<DBIx::Class::CDBICompat> - L<Class::DBI> Compat layer
-
-=item L<DBIx::Class::Schema> - schema and connection container
-
-=item L<DBIx::Class::ResultSource> - tables and table-like things
-
-=item L<DBIx::Class::ResultSet> - encapsulates a query and its results
-
-=item L<DBIx::Class::Row> - row-level methods
-
-=item L<DBIx::Class::PK> - primary key methods
-
-=item L<DBIx::Class::Relationship> - relationships between tables
-
-=back
+L<DBIx::Class::Manual::DocMap> lists each task you might want help on, and
+the modules where you will find documentation.
 
 =head1 AUTHOR
 
@@ -196,53 +190,80 @@ andyg: Andy Grundman <andy@hybridized.org>
 
 ank: Andres Kievsky
 
-blblack: Brandon Black
+ash: Ash Berlin <ash@cpan.org>
 
-LTJake: Brian Cassidy <bricas@cpan.org>
+blblack: Brandon L. Black <blblack@gmail.com>
+
+bluefeet: Aran Deltac <bluefeet@cpan.org>
+
+captainL: Luke Saunders <luke.saunders@gmail.com>
+
+castaway: Jess Robinson
 
 claco: Christopher H. Laco
 
 clkao: CL Kao
 
-typester: Daisuke Murase <typester@cpan.org>
+da5id: David Jack Olrik <djo@cpan.org>
 
 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
 
-Numa: Dan Sully <daniel@cpan.org>
+dnm: Justin Wheeler <jwheeler@datademons.com>
+
+draven: Marcus Ramberg <mramberg@cpan.org>
 
 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
 
-ningu: David Kamholz <dkamholz@cpan.org>
+dyfrgi: Michael Leuchtenburg <michael@slashhome.org>
+
+gphat: Cory G Watson <gphat@cpan.org>
 
 jesper: Jesper Krogh
 
-castaway: Jess Robinson
+jguenther: Justin Guenther <jguenther@cpan.org>
 
-quicksilver: Jules Bean
+jshirley: J. Shirley <jshirley@gmail.com>
 
-jguenther: Justin Guenther <guentherj@agr.gc.ca>
+konobi: Scott McWhirter
 
-draven: Marcus Ramberg <mramberg@cpan.org>
+LTJake: Brian Cassidy <bricas@cpan.org>
+
+ned: Neil de Carteret
 
 nigel: Nigel Metheringham <nigelm@cpan.org>
 
+ningu: David Kamholz <dkamholz@cpan.org>
+
+Numa: Dan Sully <daniel@cpan.org>
+
 paulm: Paul Makepeace
 
+penguin: K J Cheetham
+
 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
 
-sc_: Just Another Perl Hacker
+quicksilver: Jules Bean
 
-konobi: Scott McWhirter
+sc_: Just Another Perl Hacker
 
 scotty: Scotty Allen <scotty@scottyallen.com>
 
+sszabo: Stephan Szabo <sszabo@bigpanda.com>
+
 Todd Lipcon
 
+typester: Daisuke Murase <typester@cpan.org>
+
+victori: Victor Igumnov <victori@cpan.org>
+
 wdh: Will Hawes
 
+willert: Sebastian Willert <willert@cpan.org>
+
+zamolxes: Bogdan Lucaciu <bogdan@wiz.ro>
+
 =head1 LICENSE
 
 You may distribute this code under the same terms as Perl itself.
 
 =cut
-