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=1f1ffd862b73cd80f9be5d85a6aa0f13bd372e7f;hpb=0e6c5d584d334aa157caf244e062b4a24c19090c;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/DB.pm b/lib/DBIx/Class/DB.pm index 1f1ffd8..9f12a98 100644 --- a/lib/DBIx/Class/DB.pm +++ b/lib/DBIx/Class/DB.pm @@ -8,7 +8,8 @@ use DBIx::Class::Schema; use DBIx::Class::Storage::DBI; use DBIx::Class::ClassResolver::PassThrough; use DBI; -use Scalar::Util; +use Scalar::Util 'blessed'; +use namespace::clean; unless ($INC{"DBIx/Class/CDBICompat.pm"}) { warn "IMPORTANT: DBIx::Class::DB is DEPRECATED AND *WILL* BE REMOVED. DO NOT USE.\n"; @@ -16,13 +17,9 @@ unless ($INC{"DBIx/Class/CDBICompat.pm"}) { __PACKAGE__->load_components(qw/ResultSetProxy/); -{ - no warnings 'once'; - *dbi_commit = \&txn_commit; - *dbi_rollback = \&txn_rollback; -} - sub storage { shift->schema_instance(@_)->storage; } +sub dbi_commit { shift->txn_commit(@_) } +sub dbi_rollback { shift->txn_rollback(@_) } =head1 NAME @@ -36,14 +33,22 @@ instead; DBIx::Class::DB will not undergo new development and will be moved to being a CDBICompat-only component before 1.0. In order to discourage further use, documentation has been removed as of 0.08000 -=begin HIDE_BECAUSE_THIS_CLASS_IS_DEPRECATED - =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**** @@ -52,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); @@ -64,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 { @@ -72,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; @@ -80,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 { @@ -89,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(@_); } @@ -132,22 +163,30 @@ 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 { $_[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' => []); @@ -162,18 +201,19 @@ __PACKAGE__->mk_classdata('_result_source_instance' => []); sub _maybe_attach_source_to_schema { my ($class, $source) = @_; if (my $meth = $class->can('schema_instance')) { - my $schema = $class->$meth; - $schema->register_class($class, $class); - my $new_source = $schema->source($class); - %$source = %$new_source; - $schema->source_registrations->{$class} = $source; + if (my $schema = $class->$meth) { + $schema->register_class($class, $class); + my $new_source = $schema->source($class); + %$source = %$new_source; + $schema->source_registrations->{$class} = $source; + } } } sub result_source_instance { my $class = shift; $class = ref $class || $class; - + if (@_) { my $source = $_[0]; $class->_result_source_instance([$source, $class]); @@ -182,12 +222,12 @@ sub result_source_instance { } my($source, $result_class) = @{$class->_result_source_instance}; - return unless Scalar::Util::blessed($source); + return unless blessed $source; if ($result_class ne $class) { # new class - # Give this new class it's own source and register it. - $source = $source->new({ - %$source, + # Give this new class its own source and register it. + $source = $source->new({ + %$source, source_name => $class, result_class => $class } ); @@ -197,33 +237,43 @@ sub result_source_instance { 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 HIDE_BECAUSE_THIS_CLASS_IS_DEPRECATED +=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