1package DBIx::Class::DB;
2
3use strict;
4use warnings;
5
6use base qw/DBIx::Class/;
7use DBIx::Class::Schema;
8use DBIx::Class::Storage::DBI;
9use DBIx::Class::ClassResolver::PassThrough;
10use DBI;
11use Scalar::Util;
12
13unless ($INC{"DBIx/Class/CDBICompat.pm"}) {
14  warn "IMPORTANT: DBIx::Class::DB is DEPRECATED AND *WILL* BE REMOVED. DO NOT USE.\n";
15}
16
17__PACKAGE__->load_components(qw/ResultSetProxy/);
18
19{
20    no warnings 'once';
21    *dbi_commit = \&txn_commit;
22    *dbi_rollback = \&txn_rollback;
23}
24
25sub storage { shift->schema_instance(@_)->storage; }
26
27=head1 NAME
28
29DBIx::Class::DB - (DEPRECATED) classdata schema component
30
31=head1 DESCRIPTION
32
33This class is designed to support the Class::DBI connection-as-classdata style
34for DBIx::Class. You are *strongly* recommended to use a DBIx::Class::Schema
35instead; DBIx::Class::DB will not undergo new development and will be moved
36to being a CDBICompat-only component before 1.0. In order to discourage further
37use, documentation has been removed as of 0.08000
38
39=begin HIDE_BECAUSE_THIS_CLASS_IS_DEPRECATED
40
41=head1 METHODS
42
43=head2 storage
44
45Sets or gets the storage backend. Defaults to L<DBIx::Class::Storage::DBI>.
46
47=head2 class_resolver
48
49****DEPRECATED****
50
51Sets or gets the class to use for resolving a class. Defaults to
52L<DBIx::Class::ClassResolver::Passthrough>, which returns whatever you give
53it. See resolve_class below.
54
55=cut
56
57__PACKAGE__->mk_classdata('class_resolver' =>
58                          'DBIx::Class::ClassResolver::PassThrough');
59
60=head2 connection
61
62  __PACKAGE__->connection($dsn, $user, $pass, $attrs);
63
64Specifies the arguments that will be passed to DBI->connect(...) to
65instantiate the class dbh when required.
66
67=cut
68
69sub connection {
70  my ($class, @info) = @_;
71  $class->setup_schema_instance unless $class->can('schema_instance');
72  $class->schema_instance->connection(@info);
73}
74
75=head2 setup_schema_instance
76
77Creates a class method ->schema_instance which contains a DBIx::Class::Schema;
78all class-method operations are proxies through to this object. If you don't
79call ->connection in your DBIx::Class::DB subclass at load time you *must*
80call ->setup_schema_instance in order for subclasses to find the schema and
81register themselves with it.
82
83=cut
84
85sub setup_schema_instance {
86  my $class = shift;
87  my $schema = {};
88  bless $schema, 'DBIx::Class::Schema';
89  $class->mk_classdata('schema_instance' => $schema);
90}
91
92=head2 txn_begin
93
94Begins a transaction (does nothing if AutoCommit is off).
95
96=cut
97
98sub txn_begin { shift->schema_instance->txn_begin(@_); }
99
100=head2 txn_commit
101
102Commits the current transaction.
103
104=cut
105
106sub txn_commit { shift->schema_instance->txn_commit(@_); }
107
108=head2 txn_rollback
109
110Rolls back the current transaction.
111
112=cut
113
114sub txn_rollback { shift->schema_instance->txn_rollback(@_); }
115
116=head2 txn_do
117
118Executes a block of code transactionally. If this code reference
119throws an exception, the transaction is rolled back and the exception
120is rethrown. See L<DBIx::Class::Schema/"txn_do"> for more details.
121
122=cut
123
124sub txn_do { shift->schema_instance->txn_do(@_); }
125
126{
127  my $warn;
128
129  sub resolve_class {
130    warn "resolve_class deprecated as of 0.04999_02" unless $warn++;
131    return shift->class_resolver->class(@_);
132  }
133}
134
135=head2 resultset_instance
136
137Returns an instance of a resultset for this class - effectively
138mapping the L<Class::DBI> connection-as-classdata paradigm into the
139native L<DBIx::Class::ResultSet> system.
140
141=cut
142
143sub resultset_instance {
144  $_[0]->result_source_instance->resultset
145}
146
147=head2 result_source_instance
148
149Returns an instance of the result source for this class
150
151=cut
152
153__PACKAGE__->mk_classdata('_result_source_instance' => []);
154
155# Yep. this is horrific. Basically what's happening here is that
156# (with good reason) DBIx::Class::Schema copies the result source for
157# registration. Because we have a retarded setup order forced on us we need
158# to actually make our ->result_source_instance -be- the source used, and we
159# need to get the source name and schema into ourselves. So this makes it
160# happen.
161
162sub _maybe_attach_source_to_schema {
163  my ($class, $source) = @_;
164  if (my $meth = $class->can('schema_instance')) {
165    if (my $schema = $class->$meth) {
166      $schema->register_class($class, $class);
167      my $new_source = $schema->source($class);
168      %$source = %$new_source;
169      $schema->source_registrations->{$class} = $source;
170    }
171  }
172}
173
174sub result_source_instance {
175  my $class = shift;
176  $class = ref $class || $class;
177
178  if (@_) {
179    my $source = $_[0];
180    $class->_result_source_instance([$source, $class]);
181    $class->_maybe_attach_source_to_schema($source);
182    return $source;
183  }
184
185  my($source, $result_class) = @{$class->_result_source_instance};
186  return unless Scalar::Util::blessed($source);
187
188  if ($result_class ne $class) {  # new class
189    # Give this new class its own source and register it.
190    $source = $source->new({
191        %$source,
192        source_name  => $class,
193        result_class => $class
194    } );
195    $class->_result_source_instance([$source, $class]);
196    $class->_maybe_attach_source_to_schema($source);
197  }
198  return $source;
199}
200
201=head2 resolve_class
202
203****DEPRECATED****
204
205See L<class_resolver>
206
207=head2 dbi_commit
208
209****DEPRECATED****
210
211Alias for L<txn_commit>
212
213=head2 dbi_rollback
214
215****DEPRECATED****
216
217Alias for L<txn_rollback>
218
219=end HIDE_BECAUSE_THIS_CLASS_IS_DEPRECATED
220
221=head1 AUTHORS
222
223Matt S. Trout <mst@shadowcatsystems.co.uk>
224
225=head1 LICENSE
226
227You may distribute this code under the same terms as Perl itself.
228
229=cut
230
2311;
232