X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSchema.pm;h=7bbc2f14478cdf382f55199ec5175abb650249e8;hb=130c64391b48bae9eb374e931c7d6c308625bf6b;hp=4fe3a67e24b92ad2a842f7e1092ef19794877ee5;hpb=d3dec6248835b18100141f00983a5e34d81d9a97;p=dbsrgits%2FDBIx-Class.git

diff --git a/lib/DBIx/Class/Schema.pm b/lib/DBIx/Class/Schema.pm
index 4fe3a67..7bbc2f1 100644
--- a/lib/DBIx/Class/Schema.pm
+++ b/lib/DBIx/Class/Schema.pm
@@ -2,11 +2,11 @@ package DBIx::Class::Schema;
 
 use strict;
 use warnings;
+use DBIx::Class::DB;
 
-use base qw/Class::Data::Inheritable/;
 use base qw/DBIx::Class/;
 
-__PACKAGE__->load_components(qw/Exception Componentised/);
+__PACKAGE__->load_components(qw/Exception/);
 __PACKAGE__->mk_classdata('class_registrations' => {});
 
 =head1 NAME
@@ -15,7 +15,7 @@ DBIx::Class::Schema - composable schemas
 
 =head1 SYNOPSIS
 
-  in My/Schema.pm
+in My/Schema.pm
 
   package My::Schema;
 
@@ -23,30 +23,44 @@ DBIx::Class::Schema - composable schemas
 
   __PACKAGE__->load_classes(qw/Foo Bar Baz/);
 
-  in My/Schema/Foo.pm
+in My/Schema/Foo.pm
 
   package My::Schema::Foo;
 
-  use base qw/DBIx::Class::Core/;
+  use base qw/DBIx::Class/;
 
+  __PACKAGE__->load_components(qw/Core PK::Auto::Pg/); # for example
   __PACKAGE__->table('foo');
   ...
 
-  in My/DB.pm
+in My/DB.pm
 
   use My::Schema;
 
   My::Schema->compose_connection('My::DB', $dsn, $user, $pass, $attrs);
 
-  then in app code
+then in app code
 
   my @obj = My::DB::Foo->search({}); # My::DB::Foo isa My::Schema::Foo My::DB
 
 =head1 DESCRIPTION
 
+Creates database classes based on a schema. This allows you to have more than
+one concurrent connection using the same database classes, by making 
+subclasses under a new namespace for each connection. If you only need one 
+class, you should probably use L<DBIx::Class::DB> directly instead.
+
+NB: If you're used to L<Class::DBI> it's worth reading the L</SYNOPSIS>
+carefully as DBIx::Class does things a little differently. Note in
+particular which module inherits off which.
+
 =head1 METHODS
 
-=over 4
+=head2 register_class <component> <component_class>
+
+Registers the class in the schema's class_registrations. This is a hash
+containing database classes, keyed by their monikers. It's used by
+compose_connection to create/modify all the existing database classes.
 
 =cut
 
@@ -57,27 +71,93 @@ sub register_class {
   $class->class_registrations(\%reg);
 }
 
+=head2 registered_classes
+
+Simple read-only accessor for the schema's registered classes. See 
+register_class above if you want to modify it.
+
+
+=cut
+
 sub registered_classes {
   return values %{shift->class_registrations};
 }
 
+=head2  load_classes [<classes>, (<class>, <class>), {<namespace> => [<classes>]}]
+
+Uses L<Module::Find> to find all classes under the database class' namespace,
+or uses the classes you select.  Then it loads the component (using L<use>), 
+and registers them (using B<register_class>);
+
+It is possible to comment out classes with a leading '#', but note that perl
+will think it's a mistake (trying to use a comment in a qw list) so you'll
+need to add "no warnings 'qw';" before your load_classes call.
+
+=cut
+
 sub load_classes {
-  my $class = shift;
-  my @comp = grep { $_ !~ /^#/ } @_;
-  unless (@comp) {
+  my ($class, @params) = @_;
+  
+  my %comps_for;
+  
+  if (@params) {
+    foreach my $param (@params) {
+      if (ref $param eq 'ARRAY') {
+        # filter out commented entries
+        my @modules = grep { $_ !~ /^#/ } @$param;
+        
+        push (@{$comps_for{$class}}, @modules);
+      }
+      elsif (ref $param eq 'HASH') {
+        # more than one namespace possible
+        for my $comp ( keys %$param ) {
+          # filter out commented entries
+          my @modules = grep { $_ !~ /^#/ } @{$param->{$comp}};
+
+          push (@{$comps_for{$comp}}, @modules);
+        }
+      }
+      else {
+        # filter out commented entries
+        push (@{$comps_for{$class}}, $param) if $param !~ /^#/;
+      }
+    }
+  } else {
     eval "require Module::Find;";
     $class->throw("No arguments to load_classes and couldn't load".
       " Module::Find ($@)") if $@;
-    @comp = map { substr $_, length "${class}::"  }
-              Module::Find::findallmod($class);
+    my @comp = map { substr $_, length "${class}::"  } Module::Find::findallmod($class);
+    $comps_for{$class} = \@comp;
   }
-  foreach my $comp (@comp) {
-    my $comp_class = "${class}::${comp}";
-    eval "use $comp_class"; # If it fails, assume the user fixed it
-    $class->register_class($comp => $comp_class);
+
+  foreach my $prefix (keys %comps_for) {
+    foreach my $comp (@{$comps_for{$prefix}||[]}) {
+      my $comp_class = "${prefix}::${comp}";
+      print "$comp_class\n";
+      eval "use $comp_class"; # If it fails, assume the user fixed it
+      $class->register_class($comp => $comp_class);
+    }
   }
 }
 
+=head2 compose_connection <target> <@db_info>
+
+This is the most important method in this class. it takes a target namespace,
+as well as dbh connection info, and creates a L<DBIx::Class::DB> class as
+well as subclasses for each of your database classes in this namespace, using
+this connection.
+
+It will also setup a ->table method on the target class, which lets you
+resolve database classes based on the schema component name, for example
+
+  MyApp::DB->table('Foo') # returns MyApp::DB::Foo, 
+                          # which ISA MyApp::Schema::Foo
+
+This is the recommended API for accessing Schema generated classes, and 
+using it might give you instant advantages with future versions of DBIC.
+
+=cut
+
 sub compose_connection {
   my ($class, $target, @info) = @_;
   my $conn_class = "${target}::_db";
@@ -87,7 +167,7 @@ sub compose_connection {
   my %map;
   while (my ($comp, $comp_class) = each %reg) {
     my $target_class = "${target}::${comp}";
-    $class->inject_base($target_class, $conn_class, $comp_class);
+    $class->inject_base($target_class, $comp_class, $conn_class);
     $target_class->table($comp_class->table);
     @map{$comp, $comp_class} = ($target_class, $target_class);
   }
@@ -103,17 +183,22 @@ sub compose_connection {
   $conn_class->class_resolver($target);
 }
 
+=head2 setup_connection_class <$target> <@info>
+
+Sets up a database connection class to inject between the schema
+and the subclasses the schema creates.
+
+=cut
+
 sub setup_connection_class {
   my ($class, $target, @info) = @_;
-  $class->inject_base($target => 'DBIx::Class');
-  $target->load_components('DB');
+  $class->inject_base($target => 'DBIx::Class::DB');
+  #$target->load_components('DB');
   $target->connection(@info);
 }
 
 1;
 
-=back
-
 =head1 AUTHORS
 
 Matt S. Trout <mst@shadowcatsystems.co.uk>