removed C3 and no longer require it

[maypole.git] / lib / Maypole / Model / CDBI / Plain.pm

diff --git a/lib/Maypole/Model/CDBI/Plain.pm b/lib/Maypole/Model/CDBI/Plain.pm
index 2c2d869a51679f24188cdddfb2ecafd8e59ba8f3..4398fac9a92f41ba7eb221f2a920d93d845cad14 100644 (file)
--- a/lib/Maypole/Model/CDBI/Plain.pm
+++ b/lib/Maypole/Model/CDBI/Plain.pm
@@ -1,40 +1,147 @@
 package Maypole::Model::CDBI::Plain;
-use base 'Maypole::Model::CDBI';
+use strict;
+
+=head1 NAME
+
+Maypole::Model::CDBI::Plain - Class::DBI model without ::Loader
+
+=head1 SYNOPSIS
+
+    package Foo;
+    use 'Maypole::Application';
+
+    Foo->config->model("Maypole::Model::CDBI::Plain");
+    Foo->setup([qw/ Foo::SomeTable Foo::Other::Table /]);
+
+    # untaint columns and provide custom actions for each class
+
+    Foo::SomeTable->untaint_columns(email => ['email'], printable => [qw/name description/]);
+
+    Foo::Other::Table->untaint_columns ( ... );
+
+    sub Foo::SomeTable::SomeAction : Exported {
+
+        . . .
+
+    }
+
+=head1 DESCRIPTION
+
+This module allows you to use Maypole with previously set-up
+L<Class::DBI> classes; simply call C<setup> with a list reference
+of the classes you're going to use, and Maypole will work out the
+tables and set up the inheritance relationships as normal.
+
+=cut
+
+use Maypole::Config;
+use base 'Maypole::Model::CDBI::Base';
+
+use Maypole::Model::CDBI::AsForm;
+use Maypole::Model::CDBI::FromCGI;
+use CGI::Untaint::Maypole;
+
+=head1 METHODS
+
+=head1 Action Methods
+
+Action methods are methods that are accessed through web (or other public) interface.
+
+Inherited from L<Maypole::Model::CDBI::Base>
+
+=head2 do_edit
+
+If there is an object in C<$r-E<gt>objects>, then it should be edited
+with the parameters in C<$r-E<gt>params>; otherwise, a new object should
+be created with those parameters, and put back into C<$r-E<gt>objects>.
+The template should be changed to C<view>, or C<edit> if there were any
+errors. A hash of errors will be passed to the template.
+
+=head2 do_delete
+
+Inherited from Maypole::Model::CDBI::Base.
+
+This action deletes records
+
+=head2 do_search
+
+Inherited from Maypole::Model::CDBI::Base.
+
+This action method searches for database records.
+
+=head2 list
+
+Inherited from Maypole::Model::CDBI::Base.
+
+The C<list> method fills C<$r-E<gt>objects> with all of the
+objects in the class. The results are paged using a pager.
+
+=head1 Helper Methods
+
+=head2 Untainter
+
+Set the class you use to untaint and validate form data
+Note it must be of type CGI::Untaint::Maypole (takes $r arg) or CGI::Untaint
+
+=cut
+
+sub Untainter { 'CGI::Untaint::Maypole' };
+
+=head2 setup
+
+  This method is inherited from Maypole::Model::Base and calls setup_database,
+  which uses Class::DBI::Loader to create and load Class::DBI classes from
+  the given database schema.
+
+=head2 setup_database
+
+  This method loads the model classes for the application
+
+=cut
 
 sub setup_database {
     my ( $self, $config, $namespace, $classes ) = @_;
     $config->{classes}        = $classes;
+    foreach my $class (@$classes) { $namespace->load_model_subclass($class); }
+    $namespace->model_classes_loaded(1);
     $config->{table_to_class} = { map { $_->table => $_ } @$classes };
     $config->{tables}         = [ keys %{ $config->{table_to_class} } ];
 }
 
+=head2 class_of
+
+  returns class for given table
+
+=cut
+
 sub class_of {
     my ( $self, $r, $table ) = @_;
     return $r->config->{table_to_class}->{$table};
 }
 
-1;
+=head2 adopt
 
-=head1 NAME
-
-Maypole::Model::CDBI::Plain - Class::DBI model without ::Loader
+This class method is passed the name of a model class that represensts a table
+and allows the master model class to do any set-up required.
 
-=head1 SYNOPSIS
+=cut
 
-    package Foo;
-    use base 'Maypole::Application';
-    use Foo::SomeTable;
-    use Foo::Other::Table;
+sub adopt {
+    my ( $self, $child ) = @_;
+    if ( my $col = $child->stringify_column ) {
+        $child->columns( Stringify => $col );
+    }
+}
 
-    Foo->config->{model_class} = "Maypole::Model::CDBI::Plain";
-    Foo->setup([qw/ Foo::SomeTable Foo::Other::Table /]);
+=head1 SEE ALSO
 
-=head1 DESCRIPTION
+L<Maypole::Model::Base>
 
-This module allows you to use Maypole with previously set-up
-C<Class::DBI> classes; simply call C<setup> with a list reference
-of the classes you're going to use, and Maypole will work out the
-tables and set up the inheritance relationships as normal.
+L<Maypole::Model::CDBI>
 
 =cut
 
+
+1;
+
+