X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;f=lib%2FMaypole%2FModel%2FBase.pm;h=3375dfd26fba523b126e784c93e32a9779b8cfb6;hb=05b8c530848b1b7bada1e39ceb8325eb688c35d0;hp=30dacfe60015ad8227a4370fb1d5dff180c38242;hpb=43c803ceb66d273f53b343229ed1ebd6eb0fc142;p=maypole.git

diff --git a/lib/Maypole/Model/Base.pm b/lib/Maypole/Model/Base.pm
index 30dacfe..3375dfd 100644
--- a/lib/Maypole/Model/Base.pm
+++ b/lib/Maypole/Model/Base.pm
@@ -1,26 +1,30 @@
 package Maypole::Model::Base;
+
+use Maypole::Constants;
+use attributes ();
+
 our %remember;
-sub MODIFY_CODE_ATTRIBUTES { $remember{$_[1]} = $_[2]; () }
 
-sub FETCH_CODE_ATTRIBUTES { $remember{$_[1]} } 
-sub view :Exported { }
-sub edit :Exported { }
+sub MODIFY_CODE_ATTRIBUTES { $remember{ $_[1] } = $_[2]; () }
+
+sub FETCH_CODE_ATTRIBUTES { $remember{ $_[1] } }
 
 sub process {
-    my ($class, $r) = @_;
+    my ( $class, $r ) = @_;
     my $method = $r->action;
-    return if $r->{template}; # Authentication has set this, we're done.
+    return if $r->{template};    # Authentication has set this, we're done.
 
     $r->{template} = $method;
-    my $obj = $class->retrieve( $r->{args}->[0] );
-    if ($obj) {
-        $r->objects([ $obj ]);
-        shift @{$r->{args}};
-    }
-    $class->$method($r);
+    my $obj = $class->fetch_objects($r);
+    $r->objects([$obj]) if $obj;
+    $class->$method( $r, $obj, @{ $r->{args} } );
+}
+
+sub list_columns {
+    shift->display_columns;
 }
 
-sub display_columns { 
+sub display_columns {
     sort shift->columns;
 }
 
@@ -30,20 +34,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
+that defines the interface, and can't be used directly.
 
-=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 process
 
-=cut
+This is the engine of this module. Given the request object, it populates
+all the relevant variables and calls the requested action.
 
-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
 
@@ -52,8 +52,8 @@ sub do_edit { die "This is an abstract method" }
 Uses the user-defined data in C<@data> to specify a database- for
 example, by passing in a DSN. The model class should open the database,
 and create a class for each table in the database. These classes will
-then be C<adopt>ed. It should also populate C<< $config->{tables} >> and
-C<< $config->{classes} >> with the names of the classes and tables
+then be C<adopt>ed. It should also populate C<< $config->tables >> and
+C<< $config->classes >> with the names of the classes and tables
 respectively. The classes should be placed under the specified
 namespace. For instance, C<beer> should be mapped to the class
 C<BeerDB::Beer>.
@@ -64,48 +64,76 @@ C<BeerDB::Beer>.
 
 This maps between a table name and its associated class.
 
-=head2 retrieve
+=head2 fetch_objects
 
-This turns an ID into an object of the appropriate class.
+This class method is passed a request object and is expected to return an
+object of the appropriate table class from information stored in the request
+object.
 
 =head2 adopt
 
-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>.
+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.
 
 =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.
 
-=head2 Commands
+=cut 
+
+sub class_of       { die "This is an abstract method" }
+sub setup_database { die "This is an abstract method" }
+sub fetch_objects { die "This is an abstract method" }
+
+=head2 Actions
 
 =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
+The C<list> method should fill C<$r-E<gt>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 list : Exported {
+    die "This is an abstract method";
+}
+
+sub view : Exported {
+}
+
+sub edit : Exported {
+}
 
 =pod
 
@@ -116,16 +144,30 @@ 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.
 
 =cut
 
-sub column_names { my $class = shift; map { 
+sub column_names {
+    my $class = shift;
+    map {
         my $col = $_;
-        $col =~ s/_+(\w)?/ \U\1/g;
-        $_ => ucfirst $col } $class->columns }
+        $col =~ s/_+(\w)?/ \U$1/g;
+        $_ => ucfirst $col
+    } $class->columns;
+}
 
 =head2 description
 
@@ -135,5 +177,36 @@ 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 C<:Exported> attribute.
+
+=cut
+
+sub is_public {
+    my ( $self, $action ) = @_;
+    my $cv = $self->can($action);
+    return 0 unless $cv;
+    my $attrs = join " ", attributes::get($cv);
+    do {
+        warn "$action not exported" if Maypole->debug;
+        return 0;
+    } unless $attrs =~ /\bExported\b/i;
+    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;
 
+