X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;f=lib%2FMaypole%2FModel%2FBase.pm;h=b4f75c8a0824df25d0238128aeba03e13d518eeb;hb=83f49b1a6dd37085046213013288504696d5483e;hp=b592eaab30f9439d257a2a04df8775c6a504d7e7;hpb=3447ae72797ea189b6613d2c4abf9be7afe5537a;p=maypole.git diff --git a/lib/Maypole/Model/Base.pm b/lib/Maypole/Model/Base.pm index b592eaa..b4f75c8 100644 --- a/lib/Maypole/Model/Base.pm +++ b/lib/Maypole/Model/Base.pm @@ -1,35 +1,41 @@ package Maypole::Model::Base; +use strict; use Maypole::Constants; use attributes (); +# don't know why this is a global - drb our %remember; -sub MODIFY_CODE_ATTRIBUTES { $remember{ $_[1] } = $_[2]; () } - -sub FETCH_CODE_ATTRIBUTES { $remember{ $_[1] } } - -sub view : Exported { +sub MODIFY_CODE_ATTRIBUTES +{ + shift; # class name not used + my ($coderef, @attrs) = @_; + + $remember{$coderef} = \@attrs; + + # previous version took care to return an empty array, not sure why, + # but shall cargo cult it until know better + return; } -sub edit : Exported { -} +sub FETCH_CODE_ATTRIBUTES { @{ $remember{$_[1]} || [] } } sub process { my ( $class, $r ) = @_; my $method = $r->action; - return if $r->{template}; # Authentication has set this, we're done. $r->{template} = $method; - $r->objects( [] ); - my $obj = $class->retrieve( $r->{args}->[0] ); - if ($obj) { - $r->objects( [$obj] ); - shift @{ $r->{args} }; - } + 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; } @@ -40,20 +46,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 +=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. - -=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 @@ -62,8 +64,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 Ced. It should also populate C<< $config->{tables} >> and -C<< $config->{classes} >> with the names of the classes and tables +then be Ced. 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 should be mapped to the class C. @@ -74,52 +76,88 @@ 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 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 needs to return C. +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, which is the list of columns you want to view, in -the right order. +see also C =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-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 +The C method should fill C<$r-Eobjects> 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. + +=item index + +Empty Action, calls list if provided with a table. + =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 { +} + +sub index : Exported { + my ( $self, $r ) = @_; + if ($r->table) { + $r->template("list"); + return $self->list($r); + } +} + =pod Also, see the exported commands in C. @@ -129,6 +167,16 @@ 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. @@ -144,24 +192,87 @@ sub column_names { } $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 ( $self, $action, $attrs ) = @_; my $cv = $self->can($action); - return DECLINED() unless $cv; - my $attrs = join " ", attributes::get($cv); + warn "is_public failed . action is $action. self is $self" and return 0 unless $cv; + + my %attrs = (ref $attrs) ? %$attrs : map {$_ => 1} $self->method_attrs($action,$cv) ; + do { - warn "$action not exported" if Maypole->debug; - return DECLINED(); - } unless $attrs =~ /\bExported\b/i; - return OK; + warn "is_public failed. $action not exported. attributes are : ", %attrs; + return 0; + } unless $attrs{Exported}; + return 1; +} + + +=head2 add_model_superclass + +Adds model as superclass to model classes (if necessary) + +=cut + +sub add_model_superclass { return; } + +=head2 method_attrs + +Returns the list of attributes defined for a method. Maypole itself only +defines the C attribute. + +=cut + +sub method_attrs { + my ($class, $method, $cv) = @_; + + $cv ||= $class->can($method); + + return unless $cv; + + my @attrs = attributes::get($cv); + + return @attrs; +} + +=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; + + +=head1 SEE ALSO + +L, L. + +=head1 AUTHOR + +Maypole is currently maintained by Aaron Trevena. + +=head1 AUTHOR EMERITUS + +Simon Cozens, C + +Simon Flack maintained Maypole from 2.05 to 2.09 + +Sebastian Riedel, C maintained Maypole from 1.99_01 to 2.04 + +=head1 LICENSE + +You may distribute this code under the same terms as Perl itself. + +=cut