Shitload of doc fixes.

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

diff --git a/lib/Maypole/Model/CDBI.pm b/lib/Maypole/Model/CDBI.pm
index 171c9164b21de239d2dcde9e75f20200eebb2765..54325616f90cac9dfcfaa5d3ff3474639a3cf0b1 100644 (file)
--- a/lib/Maypole/Model/CDBI.pm
+++ b/lib/Maypole/Model/CDBI.pm
@@ -22,6 +22,43 @@ work of fetching rows and representing them as objects. It is a good
 model to copy if you're replacing it with other database abstraction
 modules.
 
+It implements a base set of methods required for a Maypole Data Model.
+See L<Maypole::Model::Base> for these:
+
+=over 4
+
+=item adopt
+
+=item class_of
+
+=item do_edit
+
+=item list
+
+=item related
+
+=item setup_database
+
+=back 
+
+=head1 Additional Commands
+
+=over 
+
+=item delete
+
+Surprisingly, this command causes a database record to be forever lost.
+
+=item search
+
+=head1 Helper Methods
+
+=item order
+
+=item stringify_column
+
+=item do_pager
+
 =cut
 
 sub related {
@@ -29,6 +66,16 @@ sub related {
     return keys %{ $self->meta_info('has_many') || {} };
 }
 
+#sub related_class {
+#    my ( $self, $r, $accessor ) = @_;
+#    my $related=$self->related->{$accessor};
+#    if ( my $mapping=$related->{args}->{mapping} ) {
+#      return  $related->{foreign_class}->meta_info('has_a')->{$$mapping[0]}->{foreign_class};
+#    } else { 
+#      return $related->{foreign_class};
+#    }
+#}
+
 sub do_edit : Exported {
     my ( $self, $r ) = @_;
     my $h        = CGI::Untaint->new( %{ $r->{params} } );