1 package Maypole::Model::CDBI;
2 use base qw(Maypole::Model::Base Class::DBI);
3 use Class::DBI::AsForm;
4 # use Maypole::Form::CDBI;
8 use Class::DBI::FromCGI;
9 use Class::DBI::Loader;
10 use Class::DBI::AbstractSearch;
11 use Class::DBI::Plugin::RetrieveAll;
12 use Class::DBI::Pager;
14 use Lingua::EN::Inflect::Number qw(to_PL);
20 Maypole::Model::CDBI - Model class based on Class::DBI
24 This is a master model class which uses L<Class::DBI> to do all the hard
25 work of fetching rows and representing them as objects. It is a good
26 model to copy if you're replacing it with other database abstraction
29 It implements a base set of methods required for a Maypole Data Model.
30 See L<Maypole::Model::Base> for these:
50 =head1 Additional Actions
56 Unsuprisingly, this command causes a database record to be forever lost.
70 =item stringify_column
76 Given an accessor name as a method, this function returns the class this accessor returns.
83 my ( $self, $r ) = @_;
84 return keys %{ $self->meta_info('has_many') || {} };
88 my ( $self, $r, $accessor ) = @_;
89 my $meta = $self->meta_info;
90 my @rels = keys %$meta;
93 $related = $meta->{$_}{$accessor};
96 return unless $related;
98 my $mapping = $related->{args}->{mapping};
99 if ( $mapping and @$mapping ) {
100 return $related->{foreign_class}->meta_info('has_a')->{$$mapping[0]}->{foreign_class};
103 return $related->{foreign_class};
108 sub do_edit : Exported
110 my ($self, $r, $obj) = @_;
112 my $config = $r->config;
113 my $table = $r->table;
115 my $required_cols = $config->{$table}->{required_cols} || [];
117 ($obj, my $fatal, my $creating) = $self->_do_update_or_create($r, $obj, $required_cols);
119 # handle errors, if none, proceed to view the newly created/updated object
120 my %errors = $fatal ? (FATAL => $fatal) : $obj->cgi_update_errors;
124 # Set it up as it was:
125 $r->template_args->{cgi_params} = $r->params;
126 $r->template_args->{errors} = \%errors;
128 undef $obj if $creating;
129 $r->template("edit");
133 $r->template("view");
136 $r->objects( $obj ? [$obj] : []);
139 # drb - I've (probably temporarily) split this out from do_edit, so it's
140 # reported by Mp::P::Trace
141 sub _do_update_or_create
143 my ($self, $r, $obj, $required_cols) = @_;
147 my $h = CGI::Untaint->new( %{$r->params} );
152 # We have something to edit
153 eval { $obj->update_from_cgi( $h => {required => $required_cols} ) };
159 $obj = $self->create_from_cgi( $h => {required => $required_cols} )
164 warn "$fatal" if $r->debug;
169 return $obj, $fatal, $creating;
172 sub delete : Exported {
173 return shift->SUPER::delete(@_) if caller ne "Maypole::Model::Base";
174 my ( $self, $r ) = @_;
175 $_->SUPER::delete for @{ $r->objects || [] };
176 $r->objects( [ $self->retrieve_all ] );
177 $r->{template} = "list";
181 sub stringify_column {
184 $class->columns("Stringify"),
185 ( grep { /^(name|title)$/i } $class->columns ),
186 ( grep { /(name|title)/i } $class->columns ),
187 ( grep { !/id$/i } $class->primary_columns ),
192 my ( $self, $child ) = @_;
193 $child->autoupdate(1);
194 if ( my $col = $child->stringify_column ) {
195 $child->columns( Stringify => $col );
199 sub search : Exported {
200 return shift->SUPER::search(@_) if caller ne "Maypole::Model::Base";
202 # A real CDBI search.
203 my ( $self, $r ) = @_;
204 my %fields = map { $_ => 1 } $self->columns;
205 my $oper = "like"; # For now
206 my %params = %{ $r->{params} };
207 my %values = map { $_ => { $oper, $params{$_} } }
208 grep { defined $params{$_} && length ($params{$_}) && $fields{$_} }
211 $r->template("list");
212 if ( !%values ) { return $self->list($r) }
213 my $order = $self->order($r);
214 $self = $self->do_pager($r);
218 \%values, ( $order ? { order_by => $order } : () )
222 $r->{template_args}{search} = 1;
226 my ( $self, $r ) = @_;
227 if ( my $rows = $r->config->rows_per_page ) {
228 return $r->{template_args}{pager} =
229 $self->pager( $rows, $r->query->{page} );
231 else { return $self }
235 my ( $self, $r ) = @_;
236 my %ok_columns = map { $_ => 1 } $self->columns;
238 my $order = $q->{order};
239 return unless $order and $ok_columns{$order};
240 $order .= ' DESC' if $q->{o2} and $q->{o2} eq 'desc';
244 sub list : Exported {
245 my ( $self, $r ) = @_;
246 my $order = $self->order($r);
247 $self = $self->do_pager($r);
249 $r->objects( [ $self->retrieve_all_sorted_by($order) ] );
252 $r->objects( [ $self->retrieve_all ] );
257 my ( $class, $config, $namespace, $dsn, $u, $p, $opts ) = @_;
258 $dsn ||= $config->dsn;
259 $u ||= $config->user;
260 $p ||= $config->pass;
261 $opts ||= $config->opts;
263 warn "No DSN set in config" unless $dsn;
264 $config->loader || $config->loader(
265 Class::DBI::Loader->new(
266 namespace => $namespace,
273 $config->{classes} = [ $config->{loader}->classes ];
274 $config->{tables} = [ $config->{loader}->tables ];
275 warn( 'Loaded tables: ' . join ',', @{ $config->{tables} } )
276 if $namespace->debug;
280 my ( $self, $r, $table ) = @_;
281 return $r->config->loader->_table2class($table); # why not find_class ?
286 my @pcs = $class->primary_columns;
289 @pks{@pcs}=(@{$r->{args}});
290 return $class->retrieve( %pks );
292 return $class->retrieve( $r->{args}->[0] );