X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FDB.pm;h=007c82adbfa10219e694abc2e4c7e83ab0458fab;hb=04786a4c19fe3964002b69e8a3dbb291524e0610;hp=3166c98b574009be69106866b9c79cd88c2f87f3;hpb=8452e496adea0c57b81f413e11b2f5b5b6e62c5c;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/DB.pm b/lib/DBIx/Class/DB.pm index 3166c98..007c82a 100644 --- a/lib/DBIx/Class/DB.pm +++ b/lib/DBIx/Class/DB.pm @@ -1,31 +1,27 @@ package DBIx::Class::DB; +use strict; +use warnings; + use base qw/DBIx::Class/; use DBIx::Class::Schema; use DBIx::Class::Storage::DBI; use DBIx::Class::ClassResolver::PassThrough; use DBI; -__PACKAGE__->load_components(qw/ResultSetInstance/); +__PACKAGE__->load_components(qw/ResultSetProxy/); -*dbi_commit = \&txn_commit; -*dbi_rollback = \&txn_rollback; +{ + no warnings 'once'; + *dbi_commit = \&txn_commit; + *dbi_rollback = \&txn_rollback; +} sub storage { shift->schema_instance(@_)->storage; } -sub resultset_instance { - my $class = shift; - my $source = $class->result_source; - if ($source->result_class ne $class) { - $source = $source->new($source); - $source->result_class($class); - } - return $source->resultset; -} - -=head1 NAME +=head1 NAME -DBIx::Class::DB - Simple DBIx::Class Database connection by class inheritance +DBIx::Class::DB - (DEPRECATED) classdata schema component =head1 SYNOPSIS @@ -39,13 +35,17 @@ DBIx::Class::DB - Simple DBIx::Class Database connection by class inheritance package MyDB::MyTable; use base qw/MyDB/; - __PACKAGE__->load_components('Core'); # just load this in MyDB if it will always be there + __PACKAGE__->load_components('Core'); # just load this in MyDB if it will + # always be there ... =head1 DESCRIPTION -This class provides a simple way of specifying a database connection. +This class is designed to support the Class::DBI connection-as-classdata style +for DBIx::Class. You are *strongly* recommended to use a DBIx::Class::Schema +instead; DBIx::Class::DB will not undergo new development and will be moved +to being a CDBICompat-only component before 1.0. =head1 METHODS @@ -53,16 +53,18 @@ This class provides a simple way of specifying a database connection. Sets or gets the storage backend. Defaults to L. -=head2 class_resolver ****DEPRECATED**** +=head2 class_resolver -Sets or gets the class to use for resolving a class. Defaults to +****DEPRECATED**** + +Sets or gets the class to use for resolving a class. Defaults to L, which returns whatever you give it. See resolve_class below. =cut __PACKAGE__->mk_classdata('class_resolver' => - 'DBIx::Class::ClassResolver::PassThrough'); + 'DBIx::Class::ClassResolver::PassThrough'); =head2 connection @@ -75,9 +77,24 @@ instantiate the class dbh when required. sub connection { my ($class, @info) = @_; - my $storage = DBIx::Class::Storage::DBI->new; - $storage->connect_info(\@info); - my $schema = bless({ storage => $storage }, 'DBIx::Class::Schema'); + $class->setup_schema_instance unless $class->can('schema_instance'); + $class->schema_instance->connection(@info); +} + +=head2 setup_schema_instance + +Creates a class method ->schema_instance which contains a DBIx::Class::Schema; +all class-method operations are proxies through to this object. If you don't +call ->connection in your DBIx::Class::DB subclass at load time you *must* +call ->setup_schema_instance in order for subclasses to find the schema and +register themselves with it. + +=cut + +sub setup_schema_instance { + my $class = shift; + my $schema = {}; + bless $schema, 'DBIx::Class::Schema'; $class->mk_classdata('schema_instance' => $schema); } @@ -87,7 +104,7 @@ Begins a transaction (does nothing if AutoCommit is off). =cut -sub txn_begin { $_[0]->storage->txn_begin } +sub txn_begin { shift->schema_instance->txn_begin(@_); } =head2 txn_commit @@ -95,7 +112,7 @@ Commits the current transaction. =cut -sub txn_commit { $_[0]->storage->txn_commit } +sub txn_commit { shift->schema_instance->txn_commit(@_); } =head2 txn_rollback @@ -103,7 +120,17 @@ Rolls back the current transaction. =cut -sub txn_rollback { $_[0]->storage->txn_rollback } +sub txn_rollback { shift->schema_instance->txn_rollback(@_); } + +=head2 txn_do + +Executes a block of code transactionally. If this code reference +throws an exception, the transaction is rolled back and the exception +is rethrown. See L for more details. + +=cut + +sub txn_do { shift->schema_instance->txn_do(@_); } { my $warn; @@ -114,7 +141,41 @@ sub txn_rollback { $_[0]->storage->txn_rollback } } } -1; +=head2 resultset_instance + +Returns an instance of a resultset for this class - effectively +mapping the L connection-as-classdata paradigm into the +native L system. + +=cut + +sub resultset_instance { + my $class = ref $_[0] || $_[0]; + my $source = $class->result_source_instance; + if ($source->result_class ne $class) { + $source = $source->new($source); + $source->result_class($class); + } + return $source->resultset; +} + +=head2 resolve_class + +****DEPRECATED**** + +See L + +=head2 dbi_commit + +****DEPRECATED**** + +Alias for L + +=head2 dbi_rollback + +****DEPRECATED**** + +Alias for L =head1 AUTHORS @@ -126,3 +187,4 @@ You may distribute this code under the same terms as Perl itself. =cut +1;