Shitload of doc fixes.

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

diff --git a/lib/Maypole/Model/Base.pm b/lib/Maypole/Model/Base.pm
index b6ef5f4b2156f45ad61bc8ecfca0cfb2b1d3db08..ea1632a8cce0436c7d4c669604d788cc72bbea3b 100644 (file)
--- a/lib/Maypole/Model/Base.pm
+++ b/lib/Maypole/Model/Base.pm
@@ -9,12 +9,6 @@ sub MODIFY_CODE_ATTRIBUTES { $remember{ $_[1] } = $_[2]; () }
 
 sub FETCH_CODE_ATTRIBUTES { $remember{ $_[1] } }
 
-sub view : Exported {
-}
-
-sub edit : Exported {
-}
-
 sub process {
     my ( $class, $r ) = @_;
     my $method = $r->action;
@@ -30,6 +24,10 @@ sub process {
     $class->$method( $r, $obj, @{ $r->{args} } );
 }
 
+sub list_columns {
+    shift->display_columns;
+}
+
 sub display_columns {
     sort shift->columns;
 }
@@ -40,20 +38,16 @@ Maypole::Model::Base - Base class for model classes
 
 =head1 DESCRIPTION
 
-Anyone subclassing this for a different database abstraction mechanism
-needs to provide the following methods:
+This is the base class for Maypole data models. This is an abstract class
+meant to define the interface, and can't be used directly.
 
-=head2 do_edit
+=head2 process
 
-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.
+This is the engine of this module. It populates all the relevant variables
+and calls the requested action.
 
-=cut
-
-sub do_edit { die "This is an abstract method" }
+Anyone subclassing this for a different database abstraction mechanism
+needs to provide the following methods:
 
 =head2 setup_database
 
@@ -83,43 +77,67 @@ This turns an ID into an object of the appropriate class.
 This is called on an model class representing a table and allows the
 master model class to do any set-up required. 
 
-=head2 related
-
-This can go either in the master model class or in the individual
-classes, and returns a list of has-many accessors. A brewery has many
-beers, so C<BeerDB::Brewery> needs to return C<beers>.
-
 =head2 columns
 
 This is a list of all the columns in a table. You may also override
-C<display_columns>, which is the list of columns you want to view, in
-the right order.
+see also C<display_columns>
 
 =head2 table
 
 This is the name of the table.
 
+=cut 
+
+sub class_of       { die "This is an abstract method" }
+sub setup_database { die "This is an abstract method" }
+
 =head2 Commands
 
 =over
 
+=item 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.
+
+=cut
+
+sub do_edit { die "This is an abstract method" }
+
+
 =item list
 
 The C<list> method should fill C<< $r-> objects >> with all of the
 objects in the class. You may want to page this using C<Data::Page> or
 similar.
 
+=item edit
+
+Empty Action
+
+=item view
+
+Empty Action.
+
+
 =back
 
 =cut
 
-sub class_of       { die "This is an abstract method" }
-sub setup_database { die "This is an abstract method" }
 
 sub list : Exported {
     die "This is an abstract method";
 }
 
+sub view : Exported {
+}
+
+sub edit : Exported {
+}
+
 =pod
 
 Also, see the exported commands in C<Maypole::Model::CDBI>.
@@ -129,6 +147,16 @@ Also, see the exported commands in C<Maypole::Model::CDBI>.
 Additionally, individual derived model classes may want to override the
 following methods:
 
+=head2 display_columns
+
+Returns a list of columns to display in the model. by default returns
+all columns in alphabetical order. Override this in base classes to
+change ordering, or elect not to show columns.
+
+=head2 list_columns
+
+Same as display_columns, only for listings. Defaults to display_columns
+
 =head2 column_names
 
 Return a hash mapping column names with human-readable equivalents.
@@ -152,6 +180,13 @@ A description of the class to be passed to the template.
 
 sub description { "A poorly defined class" }
 
+=head2 is_public
+
+should return true if a certain action is supported, or false otherwise. 
+Defaults to checking if the sub has the :Exported attribute.
+
+=cut
+
 sub is_public {
     my ( $self, $action ) = @_;
     my $cv = $self->can($action);
@@ -164,4 +199,15 @@ sub is_public {
     return 1;
 }
 
+=head2 related
+
+This can go either in the master model class or in the individual
+classes, and returns a list of has-many accessors. A brewery has many
+beers, so C<BeerDB::Brewery> needs to return C<beers>.
+
+=cut
+
+sub related {
+}
+
 1;