X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FDB.pm;h=9f12a981a310157b64cb202f72953ad52c3d51e7;hb=fcf32d045;hp=007c82adbfa10219e694abc2e4c7e83ab0458fab;hpb=04786a4c19fe3964002b69e8a3dbb291524e0610;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/DB.pm b/lib/DBIx/Class/DB.pm index 007c82a..9f12a98 100644 --- a/lib/DBIx/Class/DB.pm +++ b/lib/DBIx/Class/DB.pm @@ -8,51 +8,47 @@ use DBIx::Class::Schema; use DBIx::Class::Storage::DBI; use DBIx::Class::ClassResolver::PassThrough; use DBI; +use Scalar::Util 'blessed'; +use namespace::clean; -__PACKAGE__->load_components(qw/ResultSetProxy/); - -{ - no warnings 'once'; - *dbi_commit = \&txn_commit; - *dbi_rollback = \&txn_rollback; +unless ($INC{"DBIx/Class/CDBICompat.pm"}) { + warn "IMPORTANT: DBIx::Class::DB is DEPRECATED AND *WILL* BE REMOVED. DO NOT USE.\n"; } +__PACKAGE__->load_components(qw/ResultSetProxy/); + sub storage { shift->schema_instance(@_)->storage; } +sub dbi_commit { shift->txn_commit(@_) } +sub dbi_rollback { shift->txn_rollback(@_) } =head1 NAME DBIx::Class::DB - (DEPRECATED) classdata schema component -=head1 SYNOPSIS - - package MyDB; - - use base qw/DBIx::Class/; - __PACKAGE__->load_components('DB'); - - __PACKAGE__->connection('dbi:...', 'user', 'pass', \%attrs); - - package MyDB::MyTable; - - use base qw/MyDB/; - __PACKAGE__->load_components('Core'); # just load this in MyDB if it will - # always be there - - ... - =head1 DESCRIPTION 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. +to being a CDBICompat-only component before 1.0. In order to discourage further +use, documentation has been removed as of 0.08000 =head1 METHODS +Hidden. + +=begin hidden + =head2 storage Sets or gets the storage backend. Defaults to L. +=end hidden + +=cut + +=begin hidden + =head2 class_resolver ****DEPRECATED**** @@ -61,11 +57,15 @@ Sets or gets the class to use for resolving a class. Defaults to L, which returns whatever you give it. See resolve_class below. +=end hidden + =cut __PACKAGE__->mk_classdata('class_resolver' => 'DBIx::Class::ClassResolver::PassThrough'); +=begin hidden + =head2 connection __PACKAGE__->connection($dsn, $user, $pass, $attrs); @@ -73,6 +73,8 @@ __PACKAGE__->mk_classdata('class_resolver' => Specifies the arguments that will be passed to DBI->connect(...) to instantiate the class dbh when required. +=end hidden + =cut sub connection { @@ -81,6 +83,8 @@ sub connection { $class->schema_instance->connection(@info); } +=begin hidden + =head2 setup_schema_instance Creates a class method ->schema_instance which contains a DBIx::Class::Schema; @@ -89,6 +93,8 @@ 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. +=end hidden + =cut sub setup_schema_instance { @@ -98,36 +104,52 @@ sub setup_schema_instance { $class->mk_classdata('schema_instance' => $schema); } +=begin hidden + =head2 txn_begin Begins a transaction (does nothing if AutoCommit is off). +=end hidden + =cut sub txn_begin { shift->schema_instance->txn_begin(@_); } +=begin hidden + =head2 txn_commit Commits the current transaction. +=end hidden + =cut sub txn_commit { shift->schema_instance->txn_commit(@_); } +=begin hidden + =head2 txn_rollback Rolls back the current transaction. +=end hidden + =cut sub txn_rollback { shift->schema_instance->txn_rollback(@_); } +=begin hidden + =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. +=end hidden + =cut sub txn_do { shift->schema_instance->txn_do(@_); } @@ -141,49 +163,117 @@ sub txn_do { shift->schema_instance->txn_do(@_); } } } +=begin hidden + =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. +=end hidden + =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); + $_[0]->result_source_instance->resultset +} + +=begin hidden + +=head2 result_source_instance + +Returns an instance of the result source for this class + +=end hidden + +=cut + +__PACKAGE__->mk_classdata('_result_source_instance' => []); + +# Yep. this is horrific. Basically what's happening here is that +# (with good reason) DBIx::Class::Schema copies the result source for +# registration. Because we have a retarded setup order forced on us we need +# to actually make our ->result_source_instance -be- the source used, and we +# need to get the source name and schema into ourselves. So this makes it +# happen. + +sub _maybe_attach_source_to_schema { + my ($class, $source) = @_; + if (my $meth = $class->can('schema_instance')) { + if (my $schema = $class->$meth) { + $schema->register_class($class, $class); + my $new_source = $schema->source($class); + %$source = %$new_source; + $schema->source_registrations->{$class} = $source; + } } - return $source->resultset; } +sub result_source_instance { + my $class = shift; + $class = ref $class || $class; + + if (@_) { + my $source = $_[0]; + $class->_result_source_instance([$source, $class]); + $class->_maybe_attach_source_to_schema($source); + return $source; + } + + my($source, $result_class) = @{$class->_result_source_instance}; + return unless blessed $source; + + if ($result_class ne $class) { # new class + # Give this new class its own source and register it. + $source = $source->new({ + %$source, + source_name => $class, + result_class => $class + } ); + $class->_result_source_instance([$source, $class]); + $class->_maybe_attach_source_to_schema($source); + } + return $source; +} + +=begin hidden + =head2 resolve_class ****DEPRECATED**** -See L +See L + +=end hidden + +=begin hidden =head2 dbi_commit ****DEPRECATED**** -Alias for L +Alias for L + +=end hidden + +=begin hidden =head2 dbi_rollback ****DEPRECATED**** -Alias for L +Alias for L + +=end hidden -=head1 AUTHORS +=head1 AUTHOR AND CONTRIBUTORS -Matt S. Trout +See L and L in DBIx::Class =head1 LICENSE -You may distribute this code under the same terms as Perl itself. +You may distribute this code under the same terms as Perl itself =cut