sub FETCH_CODE_ATTRIBUTES { $remember{ $_[1] } }
-sub view : Exported {
-}
-
-sub edit : Exported {
-}
-
sub process {
my ( $class, $r ) = @_;
my $method = $r->action;
$class->$method( $r, $obj, @{ $r->{args} } );
}
+sub list_columns {
+ shift->display_columns;
+}
+
sub display_columns {
sort shift->columns;
}
=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
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>.
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.
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);
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;
model to copy if you're replacing it with other database abstraction
modules.
+It implements a base set of methods required for a Maypole Data Model.
+See L<Maypole::Model::Base> for these:
+
+=over 4
+
+=item adopt
+
+=item class_of
+
+=item do_edit
+
+=item list
+
+=item related
+
+=item setup_database
+
+=back
+
+=head1 Additional Commands
+
+=over
+
+=item delete
+
+Surprisingly, this command causes a database record to be forever lost.
+
+=item search
+
+=head1 Helper Methods
+
+=item order
+
+=item stringify_column
+
+=item do_pager
+
=cut
sub related {
return keys %{ $self->meta_info('has_many') || {} };
}
+#sub related_class {
+# my ( $self, $r, $accessor ) = @_;
+# my $related=$self->related->{$accessor};
+# if ( my $mapping=$related->{args}->{mapping} ) {
+# return $related->{foreign_class}->meta_info('has_a')->{$$mapping[0]}->{foreign_class};
+# } else {
+# return $related->{foreign_class};
+# }
+#}
+
sub do_edit : Exported {
my ( $self, $r ) = @_;
my $h = CGI::Untaint->new( %{ $r->{params} } );
projects / maypole.git / commitdiff