1 package Maypole::Model::CDBI;
2 use base qw(Maypole::Model::Base Class::DBI);
3 use Class::DBI::AsForm;
4 use Class::DBI::FromCGI;
5 use Class::DBI::Loader;
6 use Class::DBI::AbstractSearch;
7 use Class::DBI::Plugin::RetrieveAll;
10 use Lingua::EN::Inflect::Number qw(to_PL);
16 Maypole::Model::CDBI - Model class based on Class::DBI
20 This is a master model class which uses L<Class::DBI> to do all the hard
21 work of fetching rows and representing them as objects. It is a good
22 model to copy if you're replacing it with other database abstraction
25 It implements a base set of methods required for a Maypole Data Model.
26 See L<Maypole::Model::Base> for these:
46 =head1 Additional Actions
52 Unsuprisingly, this command causes a database record to be forever lost.
66 =item stringify_column
72 Given an accessor name as a method, this function returns the class this accessor returns.
79 my ( $self, $r ) = @_;
80 return keys %{ $self->meta_info('has_many') || {} };
84 my ( $self, $r, $accessor ) = @_;
86 my $related = $self->meta_info( has_many => $accessor ) ||
87 $self->meta_info( has_a => $accessor ) ||
90 my $mapping = $related->{args}->{mapping};
92 return $related->{foreign_class}->meta_info('has_a')->{ $$mapping[0] }
96 return $related->{foreign_class};
100 sub do_edit : Exported {
101 my ( $self, $r ) = @_;
102 my $h = CGI::Untaint->new( %{ $r->{params} } );
104 my ($obj) = @{ $r->objects || [] };
107 # We have something to edit
109 $obj->update_from_cgi( $h =>
110 { required => $r->{config}{ $r->{table} }{required_cols} || [], }
118 $self->create_from_cgi( $h =>
119 { required => $r->{config}{ $r->{table} }{required_cols} || [], }
123 warn "$fatal" if $r->debug;
127 if ( my %errors = $fatal ? (FATAL => $fatal) : $obj->cgi_update_errors ) {
129 # Set it up as it was:
130 $r->{template_args}{cgi_params} = $r->{params};
131 $r->{template_args}{errors} = \%errors;
133 undef $obj if $creating;
134 $r->template("edit");
137 $r->{template} = "view";
139 $r->objects( $obj ? [$obj] : []);
142 sub delete : Exported {
143 return shift->SUPER::delete(@_) if caller ne "Maypole::Model::Base";
144 my ( $self, $r ) = @_;
145 $_->SUPER::delete for @{ $r->objects || [] };
146 $r->objects( [ $self->retrieve_all ] );
147 $r->{template} = "list";
151 sub stringify_column {
154 $class->columns("Stringify"),
155 ( grep { /(name|title)/i } $class->columns ),
156 ( grep { !/id$/i } $class->primary_columns ),
161 my ( $self, $child ) = @_;
162 $child->autoupdate(1);
163 if ( my $col = $child->stringify_column ) {
164 $child->columns( Stringify => $col );
168 sub search : Exported {
169 return shift->SUPER::search(@_) if caller ne "Maypole::Model::Base";
171 # A real CDBI search.
172 my ( $self, $r ) = @_;
173 my %fields = map { $_ => 1 } $self->columns;
174 my $oper = "like"; # For now
175 my %params = %{ $r->{params} };
176 my %values = map { $_ => { $oper, $params{$_} } }
177 grep { defined $params{$_} && length ($params{$_}) && $fields{$_} }
180 $r->template("list");
181 if ( !%values ) { return $self->list($r) }
182 my $order = $self->order($r);
183 $self = $self->do_pager($r);
187 \%values, ( $order ? { order_by => $order } : () )
191 $r->{template_args}{search} = 1;
195 my ( $self, $r ) = @_;
196 if ( my $rows = $r->config->rows_per_page ) {
197 return $r->{template_args}{pager} =
198 $self->pager( $rows, $r->query->{page} );
200 else { return $self }
204 my ( $self, $r ) = @_;
206 my %ok_columns = map { $_ => 1 } $self->columns;
207 if ( $order = $r->query->{order} and $ok_columns{$order} ) {
208 $order .= ( $r->query->{o2} eq "desc" && " DESC" );
213 sub list : Exported {
214 my ( $self, $r ) = @_;
215 my $order = $self->order($r);
216 $self = $self->do_pager($r);
218 $r->objects( [ $self->retrieve_all_sorted_by($order) ] );
221 $r->objects( [ $self->retrieve_all ] );
226 my ( $class, $config, $namespace, $dsn, $u, $p, $opts ) = @_;
227 $dsn ||= $config->dsn;
228 $u ||= $config->user;
229 $p ||= $config->pass;
230 $opts ||= $config->opts;
232 warn "No DSN set in config" unless $dsn;
233 $config->loader || $config->loader(
234 Class::DBI::Loader->new(
235 namespace => $namespace,
242 $config->{classes} = [ $config->{loader}->classes ];
243 $config->{tables} = [ $config->{loader}->tables ];
244 warn( 'Loaded tables: ' . join ',', @{ $config->{tables} } )
245 if $namespace->debug;
249 my ( $self, $r, $table ) = @_;
250 return $r->config->loader->_table2class($table);
255 my @pcs = $class->primary_columns;
258 @pks{@pcs}=(@{$r->{args}});
259 return $class->retrieve( %pks );
261 return $class->retrieve( $r->{args}->[0] );