X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;f=lib%2FMaypole%2FModel%2FBase.pm;h=d0e9ba81670c357160685195b205736513712b0a;hb=d3a3498e58b23918b3311da94f706bbfe2a576ee;hp=908a2fca294a926e2f412c5daee3d2345479c9d7;hpb=d09e000fc977211b8bd1a77285a952421b60aa7a;p=maypole.git

diff --git a/lib/Maypole/Model/Base.pm b/lib/Maypole/Model/Base.pm
index 908a2fc..d0e9ba8 100644
--- a/lib/Maypole/Model/Base.pm
+++ b/lib/Maypole/Model/Base.pm
@@ -1,102 +1,205 @@
-package Apache::MVC::Model::Base;
+package Maypole::Model::Base;
+
+use strict;
+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) = @_;
-    $r->template( my $method = $r->action );
-    $r->objects([ $class->retrieve(shift @{$r->{args}}) ]);
-    $class->$method($r);
+    my ( $class, $r ) = @_;
+    my $method = $r->action;
+    return if $r->{template};    # Authentication has set this, we're done.
+
+    $r->{template} = $method;
+    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 {
+    sort shift->columns;
 }
 
 =head1 NAME
 
-Apache::MVC::Model::Base - Base class for model classes
+Maypole::Model::Base - Base class for model classes
 
 =head1 DESCRIPTION
 
+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 process
+
+This is the engine of this module. Given the request object, it populates
+all the relevant variables and calls the requested action.
+
 Anyone subclassing this for a different database abstraction mechanism
 needs to provide the following methods:
 
-=head2 do_edit
+=head2 setup_database
 
-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.
+    $model->setup_database($config, $namespace, @data)
 
-=cut
+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
+respectively. The classes should be placed under the specified
+namespace. For instance, C<beer> should be mapped to the class
+C<BeerDB::Beer>.
 
-sub do_edit { die "This is an abstract method" }
+=head2 class_of
 
-=head2 retrieve
+    $model->class_of($r, $table)
 
-This turns an ID into an object of the appropriate class.
+This maps between a table name and its associated class.
 
-=head2 adopt
+=head2 fetch_objects
 
-This is called on an model class representing a table and allows the
-master model class to do any set-up required. 
+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 related
+=head2 adopt
 
-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 the columns in a table.
+This is a list of all the columns in a table. You may also override
+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 list :Exported { 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<Apache::MVC::Model::CDBI>.
+Also, see the exported commands in C<Maypole::Model::CDBI>.
 
 =head1 Other overrides
 
 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 { $_ => ucfirst $_ } $class->columns }
+sub column_names {
+    my $class = shift;
+    map {
+        my $col = $_;
+        $col =~ s/_+(\w)?/ \U$1/g;
+        $_ => ucfirst $col
+    } $class->columns;
+}
 
-=head2 description
+=head2 is_public
 
-A description of the class to be passed to the template.
+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 description { "A poorly defined class" }
+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;
 
+