X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;f=lib%2FMaypole%2FModel%2FBase.pm;h=580e6e1c942cb7cbfd3be63dae9f1cd4c6a74590;hb=5e9b1336d1f20d57953e3e419fa7d68e79723528;hp=c4c959f7c7c42a4c2b0b0ec933bc56242120b83b;hpb=9bbeafd23117d2b489a298cc002a97b133de17bd;p=maypole.git diff --git a/lib/Maypole/Model/Base.pm b/lib/Maypole/Model/Base.pm index c4c959f..580e6e1 100644 --- a/lib/Maypole/Model/Base.pm +++ b/lib/Maypole/Model/Base.pm @@ -1,16 +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) = @_; - $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; + $r->objects([ $class->fetch_objects($r) ]); + $class->$method( $r, $obj, @{ $r->{args} } ); +} + +sub list_columns { + shift->display_columns; +} + +sub display_columns { + sort shift->columns; } =head1 NAME @@ -19,20 +33,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-Eobjects>, then it should be edited -with the parameters in C<$r-Eparams>; otherwise, a new object should -be created with those parameters, and put back into C<$r-Eobjects>. -The template should be changed to C, or C 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 @@ -53,46 +63,74 @@ C. 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 method should populate $r->objects from $r->{args}. =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 needs to return C. - =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 =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" } +sub fetch_objects { die "This is an abstract method" } + =head2 Commands =over +=item do_edit + +If there is an object in C<$r-Eobjects>, then it should be edited +with the parameters in C<$r-Eparams>; otherwise, a new object should +be created with those parameters, and put back into C<$r-Eobjects>. +The template should be changed to C, or C 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 method should fill C<< $r-> objects >> with all of the objects in the class. You may want to page this using C 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 @@ -103,13 +141,30 @@ Also, see the exported commands in C. 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 @@ -119,5 +174,34 @@ A description of the class to be passed to the template. sub description { "A poorly defined class" } -1; +=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); + 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 needs to return C. + +=cut + +sub related { +} + +1;