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] );
145 ($obj,$errors) = $class->_do_update($r,$obj);
147 ($obj,$errors) = $class->_do_create($r);
150 # handle errors, if none, proceed to view the newly created/updated object
152 # pass errors to template
153 $r->template_args->{errors} = $errors;
154 foreach my $error (keys %$errors) {
155 $r->template_args->{errors}{ucfirst($error)} = $errors->{$error}
158 # Set it up as it was:
159 $r->template_args->{cgi_params} = $r->params;
160 $r->template("edit");
162 $r->template("view");
165 $r->objects( $obj ? [$obj] : []);
169 my ($class,$r,$obj) = @_;
171 my $dfv_results = Data::FormValidator->check($r->{params}, $class->dfv_profile);
174 if ( $dfv_results->has_missing ) { # missing fields
175 foreach my $field ( $dfv_results->missing ) {
176 $errors->{$field} = "$field is required";
179 if ( $dfv_results->has_invalid ) { # Print the name of invalid fields
180 foreach my $field ( $dfv_results->invalid ) {
181 $errors->{$field} = "$field is invalid: " . $dfv_results->invalid( $field );
185 my $this_class_params = { map { $_ => $r->{params}{$_} } $class->columns };
187 # update or make other related (must_have, might_have, has_many etc )
189 foreach my $accssr ( grep ( !(exists $this_class_params->{$_}) , keys %{$r->{params}} ) ) {
190 # get related object if it exists
191 my $rel_meta = $class->related_meta('r',$accssr);
193 $class->_carp("No relationship for $accssr in " . ref($class));
197 my $rel_type = $rel_meta->{name};
198 my $fclass = $rel_meta->{foreign_class};
200 $rel_obj = $fclass->retrieve($r->params->{$accssr});
201 # update or create related object
202 ($rel_obj, $errs) = ($rel_obj)
203 ? $fclass->_do_update($r, $rel_obj)
204 : $obj->_create_related($accssr, $r->params);
205 $errors->{$accssr} = $errs if ($errs);
210 $obj->set( %$this_class_params );
214 return ($obj,$errors);
221 my $this_class_params = { map { $_ => $r->{params}{$_} } $class->columns };
224 my $dfv_results = Data::FormValidator->check($r->{params}, $class->dfv_profile);
225 if ($dfv_results->success) {
226 $obj = $class->create($this_class_params);
229 if ( $dfv_results->has_missing ) { # missing fields
230 foreach my $field ( $dfv_results->missing ) {
231 $errors->{$field} = "$field is required";
234 if ( $dfv_results->has_invalid ) { # Print the name of invalid fields
235 foreach my $field ( $dfv_results->invalid ) {
236 $errors->{$field} = "$field is invalid: " . $dfv_results->invalid( $field );
241 # Make other related (must_have, might_have, has_many etc )
243 foreach my $accssr ( grep ( !(exists $this_class_params->{$_}) , keys %{$r->{params}} ) ) {
244 my ($rel_obj, $errs) = $obj->_create_related($accssr, $r->{params}{$accssr});
245 $errors->{$accssr} = $errs if ($errs);
248 return ($obj,$errors);
252 sub _create_related {
253 # self is object or class, accssr is accssr to relationship, params are
254 # data for relobject, and created is the array ref to store objs
255 my ( $self, $accssr, $params ) = @_;
256 $self->_croak ("Can't make related object without a parent $self object") unless (ref $self);
258 my $rel_meta = $self->related_meta('r',$accssr);
260 $self->_carp("No relationship for $accssr in " . ref($self));
264 my $rel_type = $rel_meta->{name};
265 my $fclass = $rel_meta->{foreign_class};
269 # Set up params for might_have, has_many, etc
270 if ($rel_type ne 'has_own' and $rel_type ne 'has_a') {
271 # Foreign Key meta data not very standardized in CDBI
272 my $fkey= $rel_meta->{args}{foreign_key} || $rel_meta->{foreign_column};
273 unless ($fkey) { die " Could not determine foreign key for $fclass"; }
274 my %data = (%$params, $fkey => $self->id);
275 %data = ( %data, %{$rel_meta->{args}->{constraint} || {}} );
276 ($rel, $errs) = $fclass->_do_create(\%data);
279 ($rel, $errs) = $fclass->_do_create($params);
281 $self->$accssr($rel->id);
285 return ($rel, $errs);
291 Inherited from Maypole::Model::CDBI::Base.
293 This action deletes records
297 Inherited from Maypole::Model::CDBI::Base.
299 This action method searches for database records.
303 Inherited from Maypole::Model::CDBI::Base.
305 The C<list> method fills C<$r-E<gt>objects> with all of the
306 objects in the class. The results are paged using a pager.
313 # get COLUMN INFO from DB
314 $class->SUPER::_column_info() unless (ref $class->COLUMN_INFO);
316 # update with required columns from DFV Profile
317 my $profile = $class->dfv_profile;
318 $class->required_columns($profile->{required});
320 return $class->COLUMN_INFO;
327 L<Maypole::Model::Base>
329 L<Maypole::Model::CDBI::Base>
337 You may distribute this code under the same terms as Perl itself.