Commit | Line | Data |
ea2e61bf |
1 | package DBIx::Class::Table; |
2 | |
3 | use strict; |
4 | use warnings; |
5 | |
95a70f01 |
6 | use DBIx::Class::Cursor; |
7 | |
8 | use base qw/Class::Data::Inheritable/; |
ea2e61bf |
9 | |
10 | __PACKAGE__->mk_classdata('_columns' => {}); |
11 | |
ea2e61bf |
12 | __PACKAGE__->mk_classdata('_table_name'); |
13 | |
34d52be2 |
14 | __PACKAGE__->mk_classdata('table_alias'); # FIXME: Doesn't actually do anything yet! |
15 | |
95a70f01 |
16 | __PACKAGE__->mk_classdata('_cursor_class' => 'DBIx::Class::Cursor'); |
17 | |
34d52be2 |
18 | =head1 NAME |
19 | |
20 | DBIx::Class::Table - Basic table methods |
21 | |
22 | =head1 SYNOPSIS |
23 | |
24 | =head1 DESCRIPTION |
25 | |
26 | This class is responsible for defining and doing basic operations on |
27 | L<DBIx::Class> objects. |
28 | |
29 | =head1 METHODS |
30 | |
31 | =over 4 |
32 | |
33 | =cut |
9bc6db13 |
34 | |
ea2e61bf |
35 | sub new { |
36 | my ($class, $attrs) = @_; |
37 | $class = ref $class if ref $class; |
38 | my $new = bless({ _column_data => { } }, $class); |
39 | if ($attrs) { |
8fe001e1 |
40 | die "attrs must be a hashref" unless ref($attrs) eq 'HASH'; |
ea2e61bf |
41 | while (my ($k, $v) = each %{$attrs}) { |
510ca912 |
42 | $new->store_column($k => $v); |
ea2e61bf |
43 | } |
44 | } |
8fe001e1 |
45 | return $new; |
ea2e61bf |
46 | } |
47 | |
48 | sub insert { |
49 | my ($self) = @_; |
c687b87e |
50 | return if $self->in_database; |
c1d23573 |
51 | #use Data::Dumper; warn Dumper($self); |
ea2e61bf |
52 | my $sth = $self->_get_sth('insert', [ keys %{$self->{_column_data}} ], |
53 | $self->_table_name, undef); |
54 | $sth->execute(values %{$self->{_column_data}}); |
604d9f38 |
55 | $sth->finish; |
c687b87e |
56 | $self->in_database(1); |
8fe001e1 |
57 | $self->{_dirty_columns} = {}; |
ea2e61bf |
58 | return $self; |
59 | } |
60 | |
604d9f38 |
61 | sub in_database { |
c687b87e |
62 | my ($self, $val) = @_; |
63 | $self->{_in_database} = $val if @_ > 1; |
64 | return $self->{_in_database}; |
604d9f38 |
65 | } |
66 | |
ea2e61bf |
67 | sub create { |
68 | my ($class, $attrs) = @_; |
8fe001e1 |
69 | die "create needs a hashref" unless ref $attrs eq 'HASH'; |
ea2e61bf |
70 | return $class->new($attrs)->insert; |
71 | } |
72 | |
73 | sub update { |
74 | my ($self) = @_; |
c687b87e |
75 | die "Not in database" unless $self->in_database; |
ea2e61bf |
76 | my @to_update = keys %{$self->{_dirty_columns} || {}}; |
a3018bd3 |
77 | return -1 unless @to_update; |
ea2e61bf |
78 | my $sth = $self->_get_sth('update', \@to_update, |
79 | $self->_table_name, $self->_ident_cond); |
a3018bd3 |
80 | my $rows = $sth->execute( (map { $self->{_column_data}{$_} } @to_update), |
ea2e61bf |
81 | $self->_ident_values ); |
604d9f38 |
82 | $sth->finish; |
a3018bd3 |
83 | if ($rows == 0) { |
84 | die "Can't update $self: row not found"; |
85 | } elsif ($rows > 1) { |
86 | die "Can't update $self: updated more than one row"; |
87 | } |
ea2e61bf |
88 | $self->{_dirty_columns} = {}; |
89 | return $self; |
90 | } |
91 | |
92 | sub delete { |
a3018bd3 |
93 | my $self = shift; |
94 | if (ref $self) { |
c687b87e |
95 | die "Not in database" unless $self->in_database; |
b8e1e21f |
96 | #warn $self->_ident_cond.' '.join(', ', $self->_ident_values); |
a3018bd3 |
97 | my $sth = $self->_get_sth('delete', undef, |
98 | $self->_table_name, $self->_ident_cond); |
99 | $sth->execute($self->_ident_values); |
100 | $sth->finish; |
c687b87e |
101 | $self->in_database(undef); |
a3018bd3 |
102 | } else { |
12bbb339 |
103 | my $attrs = { }; |
104 | if (@_ > 1 && ref $_[$#_] eq 'HASH') { |
105 | $attrs = { %{ pop(@_) } }; |
106 | } |
a3018bd3 |
107 | my $query = (ref $_[0] eq 'HASH' ? $_[0] : {@_}); |
12bbb339 |
108 | my ($cond, @param) = $self->_cond_resolve($query, $attrs); |
a3018bd3 |
109 | my $sth = $self->_get_sth('delete', undef, $self->_table_name, $cond); |
12bbb339 |
110 | $sth->execute(@param); |
a3018bd3 |
111 | $sth->finish; |
112 | } |
ea2e61bf |
113 | return $self; |
114 | } |
115 | |
510ca912 |
116 | sub get_column { |
ea2e61bf |
117 | my ($self, $column) = @_; |
8fe001e1 |
118 | die "Can't fetch data as class method" unless ref $self; |
510ca912 |
119 | die "No such column '${column}'" unless $self->_columns->{$column}; |
c1d23573 |
120 | return $self->{_column_data}{$column} |
121 | if exists $self->{_column_data}{$column}; |
122 | return undef; |
ea2e61bf |
123 | } |
124 | |
510ca912 |
125 | sub set_column { |
126 | my $self = shift; |
127 | my ($column) = @_; |
128 | my $ret = $self->store_column(@_); |
129 | $self->{_dirty_columns}{$column} = 1; |
130 | return $ret; |
131 | } |
132 | |
133 | sub store_column { |
ea2e61bf |
134 | my ($self, $column, $value) = @_; |
510ca912 |
135 | die "No such column '${column}'" unless $self->_columns->{$column}; |
136 | die "set_column called for ${column} without value" if @_ < 3; |
137 | return $self->{_column_data}{$column} = $value; |
ea2e61bf |
138 | } |
139 | |
ea2e61bf |
140 | sub _register_columns { |
141 | my ($class, @cols) = @_; |
142 | my $names = { %{$class->_columns} }; |
143 | $names->{$_} ||= {} for @cols; |
144 | $class->_columns($names); |
145 | } |
146 | |
147 | sub _mk_column_accessors { |
148 | my ($class, @cols) = @_; |
510ca912 |
149 | $class->mk_group_accessors('column' => @cols); |
ea2e61bf |
150 | } |
151 | |
510ca912 |
152 | sub add_columns { |
8fe001e1 |
153 | my ($class, @cols) = @_; |
154 | $class->_register_columns(@cols); |
155 | $class->_mk_column_accessors(@cols); |
156 | } |
157 | |
158 | sub retrieve_from_sql { |
159 | my ($class, $cond, @vals) = @_; |
a3018bd3 |
160 | $cond =~ s/^\s*WHERE//i; |
604d9f38 |
161 | my $attrs = (ref $vals[$#vals] eq 'HASH' ? pop(@vals) : {}); |
162 | my @cols = $class->_select_columns($attrs); |
8fe001e1 |
163 | my $sth = $class->_get_sth( 'select', \@cols, $class->_table_name, $cond); |
b8e1e21f |
164 | #warn "$cond @vals"; |
54644855 |
165 | return $class->sth_to_objects($sth, \@vals, \@cols, { where => $cond }); |
510ca912 |
166 | } |
167 | |
168 | sub sth_to_objects { |
54644855 |
169 | my ($class, $sth, $args, $cols, $attrs) = @_; |
510ca912 |
170 | my @cols = ((ref $cols eq 'ARRAY') ? @$cols : @{$sth->{NAME_lc}} ); |
95a70f01 |
171 | my $cursor_class = $class->_cursor_class; |
172 | eval "use $cursor_class;"; |
54644855 |
173 | my $cursor = $cursor_class->new($class, $sth, $args, \@cols, $attrs); |
95a70f01 |
174 | return (wantarray ? $cursor->all : $cursor); |
8fe001e1 |
175 | } |
176 | |
c1d23573 |
177 | sub _row_to_object { # WARNING: Destructive to @$row |
178 | my ($class, $cols, $row) = @_; |
179 | my $new = $class->new; |
180 | $new->store_column($_, shift @$row) for @$cols; |
181 | $new->in_database(1); |
182 | return $new; |
183 | } |
184 | |
8fe001e1 |
185 | sub search { |
12bbb339 |
186 | my $class = shift; |
187 | my $attrs = { }; |
188 | if (@_ > 1 && ref $_[$#_] eq 'HASH') { |
189 | $attrs = { %{ pop(@_) } }; |
190 | } |
191 | my $query = ref $_[0] eq "HASH" ? shift: {@_}; |
192 | my ($cond, @param) = $class->_cond_resolve($query, $attrs); |
c687b87e |
193 | return $class->retrieve_from_sql($cond, @param, $attrs); |
a3018bd3 |
194 | } |
195 | |
196 | sub search_like { |
197 | my $class = shift; |
12bbb339 |
198 | my $attrs = { }; |
199 | if (@_ > 1 && ref $_[$#_] eq 'HASH') { |
200 | $attrs = pop(@_); |
201 | } |
202 | return $class->search(@_, { %$attrs, cmp => 'LIKE' }); |
8fe001e1 |
203 | } |
204 | |
205 | sub _select_columns { |
206 | return keys %{$_[0]->_columns}; |
207 | } |
208 | |
209 | sub copy { |
210 | my ($self, $changes) = @_; |
211 | my $new = bless({ _column_data => { %{$self->{_column_data}}} }, ref $self); |
510ca912 |
212 | $new->set_column($_ => $changes->{$_}) for keys %$changes; |
a3018bd3 |
213 | return $new->insert; |
214 | } |
215 | |
12bbb339 |
216 | sub _cond_resolve { |
217 | my ($self, $query, $attrs) = @_; |
604d9f38 |
218 | return '1 = 1' unless keys %$query; |
12bbb339 |
219 | my $op = $attrs->{'cmp'} || '='; |
a3018bd3 |
220 | my $cond = join(' AND ', |
221 | map { (defined $query->{$_} |
222 | ? "$_ $op ?" |
223 | : (do { delete $query->{$_}; "$_ IS NULL"; })); |
224 | } keys %$query); |
12bbb339 |
225 | return ($cond, values %$query); |
8fe001e1 |
226 | } |
227 | |
510ca912 |
228 | sub table { |
229 | shift->_table_name(@_); |
230 | } |
231 | |
95a70f01 |
232 | sub find_or_create { |
233 | my $class = shift; |
234 | my $hash = ref $_[0] eq "HASH" ? shift: {@_}; |
235 | my ($exists) = $class->search($hash); |
236 | return defined($exists) ? $exists : $class->create($hash); |
237 | } |
238 | |
239 | sub retrieve_all { |
240 | my ($class) = @_; |
241 | return $class->retrieve_from_sql( '1' ); |
242 | } |
243 | |
ea2e61bf |
244 | 1; |
34d52be2 |
245 | |
246 | =back |
247 | |
248 | =head1 AUTHORS |
249 | |
250 | Matt S. Trout <perl-stuff@trout.me.uk> |
251 | |
252 | =head1 LICENSE |
253 | |
254 | You may distribute this code under the same terms as Perl itself. |
255 | |
256 | =cut |
257 | |