1 package Maypole::Model::CDBI::DFV;
6 Maypole::Model::CDBI::DFV - Class::DBI::DFV model for Maypole.
11 use 'Maypole::Application';
13 Foo->config->model("Maypole::Model::CDBI::DFV");
14 Foo->setup([qw/ Foo::SomeTable Foo::Other::Table /]);
16 # Look ma, no untainting
18 sub Foo::SomeTable::SomeAction : Exported {
26 This module allows you to use Maypole with previously set-up
27 L<Class::DBI> classes that use Class::DBI::DFV;
29 Simply call C<setup> with a list reference of the classes you're going to use,
30 and Maypole will work out the tables and set up the inheritance relationships
33 Better still, it will also set use your DFV profile to validate input instead
34 of CGI::Untaint. For teh win!!
39 use Data::FormValidator;
43 use Maypole::Model::CDBI::AsForm;
45 use base qw(Maypole::Model::CDBI::Base);
47 Maypole::Config->mk_accessors(qw(table_to_class _COLUMN_INFO));
53 This method is inherited from Maypole::Model::Base and calls setup_database,
54 which uses Class::DBI::Loader to create and load Class::DBI classes from
55 the given database schema.
59 This method loads the model classes for the application
64 my ( $self, $config, $namespace, $classes ) = @_;
65 $config->{classes} = $classes;
66 foreach my $class (@$classes) {
67 $namespace->load_model_subclass($class);
69 $namespace->model_classes_loaded(1);
70 $config->{table_to_class} = { map { $_->table => $_ } @$classes };
71 $config->{tables} = [ keys %{ $config->{table_to_class} } ];
76 returns class for given table
81 my ( $self, $r, $table ) = @_;
82 return $r->config->{table_to_class}->{$table};
87 This class method is passed the name of a model class that represensts a table
88 and allows the master model class to do any set-up required.
93 my ( $self, $child ) = @_;
94 if ( my $col = $child->stringify_column ) {
95 $child->columns( Stringify => $col );
101 Checks parameters against the DFV profile for the class, returns the results
104 my $dfv_results = __PACKAGE__->check_params($r->params);
109 my ($class,$params) = @_;
110 return Data::FormValidator->check($params, $class->dfv_profile);
114 =head1 Action Methods
116 Action methods are methods that are accessed through web (or other public) interface.
118 Inherited from L<Maypole::Model::CDBI::Base> except do_edit (below)
122 If there is an object in C<$r-E<gt>objects>, then it should be edited
123 with the parameters in C<$r-E<gt>params>; otherwise, a new object should
124 be created with those parameters, and put back into C<$r-E<gt>objects>.
125 The template should be changed to C<view>, or C<edit> if there were any
126 errors. A hash of errors will be passed to the template.
130 sub do_edit : Exported {
131 my ($class, $r, $obj) = @_;
133 my $config = $r->config;
134 my $table = $r->table;
136 # handle cancel button hit
137 if ( $r->params->{cancel} ) {
138 $r->template("list");
139 $r->objects( [$class->retrieve_all] );
146 ($obj,$errors) = $class->_do_update($r,$obj);
148 ($obj,$errors) = $class->_do_create($r);
151 # handle errors, if none, proceed to view the newly created/updated object
153 # pass errors to template
154 $r->template_args->{errors} = $errors;
155 foreach my $error (keys %$errors) {
156 $r->template_args->{errors}{ucfirst($error)} = $errors->{$error}
159 # Set it up as it was:
160 $r->template_args->{cgi_params} = $r->params;
161 $r->template("edit");
163 $r->template("view");
166 $r->objects( $obj ? [$obj] : []);
170 my ($class,$r,$obj) = @_;
172 my $dfv_results = Data::FormValidator->check($r->{params}, $class->dfv_profile);
175 if ( $dfv_results->has_missing ) { # missing fields
176 foreach my $field ( $dfv_results->missing ) {
177 $errors->{$field} = "$field is required";
180 if ( $dfv_results->has_invalid ) { # Print the name of invalid fields
181 foreach my $field ( $dfv_results->invalid ) {
182 $errors->{$field} = "$field is invalid: " . $dfv_results->invalid( $field );
187 my $this_class_params = {};
188 foreach my $param ( $class->columns ) {
189 next if ($param eq $class->columns('Primary'));
190 my $value = $r->params->{$param};
191 next unless (defined $value);
192 $this_class_params->{$param} = ( $value eq '' ) ? undef : $value;
195 # update or make other related (must_have, might_have, has_many etc )
197 foreach my $accssr ( grep ( !(exists $this_class_params->{$_}) , keys %{$r->{params}} ) ) {
198 # get related object if it exists
199 my $rel_meta = $class->related_meta('r',$accssr);
201 $r->warn("[_do_update] No relationship for $accssr in " . ref($class));
205 my $rel_type = $rel_meta->{name};
206 my $fclass = $rel_meta->{foreign_class};
208 $rel_obj = $fclass->retrieve($r->params->{$accssr});
209 # update or create related object
210 ($rel_obj, $errs) = ($rel_obj)
211 ? $fclass->_do_update($r, $rel_obj)
212 : $obj->_create_related($accssr, $r->params);
213 $errors->{$accssr} = $errs if ($errs);
218 $obj->set( %$this_class_params );
222 return ($obj,$errors);
229 my $this_class_params = {};
230 foreach my $param ( $class->columns ) {
231 next if ($param eq $class->columns('Primary'));
232 my $value = $r->params->{$param};
233 next unless (defined $value);
234 $this_class_params->{$param} = ( $value eq '' ) ? undef : $value;
239 my $dfv_results = Data::FormValidator->check($r->{params}, $class->dfv_profile);
240 if ($dfv_results->success) {
241 $obj = $class->create($this_class_params);
244 if ( $dfv_results->has_missing ) { # missing fields
245 foreach my $field ( $dfv_results->missing ) {
246 $errors->{$field} = "$field is required";
249 if ( $dfv_results->has_invalid ) { # Print the name of invalid fields
250 foreach my $field ( $dfv_results->invalid ) {
251 $errors->{$field} = "$field is invalid: " . $dfv_results->invalid( $field );
256 # Make other related (must_have, might_have, has_many etc )
258 foreach my $accssr ( grep ( !(exists $this_class_params->{$_}) , keys %{$r->{params}} ) ) {
259 my ($rel_obj, $errs) = $obj->_create_related($accssr, $r->{params}{$accssr});
260 $errors->{$accssr} = $errs if ($errs);
263 return ($obj,$errors);
267 sub _create_related {
268 # self is object or class, accssr is accssr to relationship, params are
269 # data for relobject, and created is the array ref to store objs
270 my ( $self, $accssr, $params ) = @_;
271 $self->_croak ("Can't make related object without a parent $self object") unless (ref $self);
273 my $rel_meta = $self->related_meta('r',$accssr);
275 $self->_carp("[_create_related] No relationship for $accssr in " . ref($self));
279 my $rel_type = $rel_meta->{name};
280 my $fclass = $rel_meta->{foreign_class};
284 # Set up params for might_have, has_many, etc
285 if ($rel_type ne 'has_own' and $rel_type ne 'has_a') {
286 # Foreign Key meta data not very standardized in CDBI
287 my $fkey= $rel_meta->{args}{foreign_key} || $rel_meta->{foreign_column};
288 unless ($fkey) { die " Could not determine foreign key for $fclass"; }
289 my %data = (%$params, $fkey => $self->id);
290 %data = ( %data, %{$rel_meta->{args}->{constraint} || {}} );
291 ($rel, $errs) = $fclass->_do_create(\%data);
294 ($rel, $errs) = $fclass->_do_create($params);
296 $self->$accssr($rel->id);
300 return ($rel, $errs);
306 Inherited from Maypole::Model::CDBI::Base.
308 This action deletes records
312 Inherited from Maypole::Model::CDBI::Base.
314 This action method searches for database records.
318 Inherited from Maypole::Model::CDBI::Base.
320 The C<list> method fills C<$r-E<gt>objects> with all of the
321 objects in the class. The results are paged using a pager.
328 # get COLUMN INFO from DB
329 $class->SUPER::_column_info() unless (ref $class->COLUMN_INFO);
331 # update with required columns from DFV Profile
332 my $profile = $class->dfv_profile;
333 $class->required_columns($profile->{required});
335 return $class->COLUMN_INFO;
342 L<Maypole::Model::Base>
344 L<Maypole::Model::CDBI::Base>
352 You may distribute this code under the same terms as Perl itself.