1 package Maypole::Model::Base;
4 use Maypole::Constants;
9 sub MODIFY_CODE_ATTRIBUTES
11 shift; # class name not used
12 my ($coderef, @attrs) = @_;
14 $remember{$coderef} = \@attrs;
16 # previous version took care to return an empty array, not sure why,
17 # but shall cargo cult it until know better
21 sub FETCH_CODE_ATTRIBUTES { @{ $remember{$_[1]} || [] } }
24 my ( $class, $r ) = @_;
25 my $method = $r->action;
26 return if $r->{template}; # Authentication has set this, we're done.
28 $r->{template} = $method;
29 my $obj = $class->fetch_objects($r);
30 $r->objects([$obj]) if $obj;
31 $class->$method( $r, $obj, @{ $r->{args} } );
35 shift->display_columns;
44 Maypole::Model::Base - Base class for model classes
48 This is the base class for Maypole data models. This is an abstract class
49 that defines the interface, and can't be used directly.
53 This is the engine of this module. Given the request object, it populates
54 all the relevant variables and calls the requested action.
56 Anyone subclassing this for a different database abstraction mechanism
57 needs to provide the following methods:
61 $model->setup_database($config, $namespace, @data)
63 Uses the user-defined data in C<@data> to specify a database- for
64 example, by passing in a DSN. The model class should open the database,
65 and create a class for each table in the database. These classes will
66 then be C<adopt>ed. It should also populate C<< $config->tables >> and
67 C<< $config->classes >> with the names of the classes and tables
68 respectively. The classes should be placed under the specified
69 namespace. For instance, C<beer> should be mapped to the class
74 $model->class_of($r, $table)
76 This maps between a table name and its associated class.
80 This class method is passed a request object and is expected to return an
81 object of the appropriate table class from information stored in the request
86 This class method is passed the name of a model class that represensts a table
87 and allows the master model class to do any set-up required.
91 This is a list of all the columns in a table. You may also override
92 see also C<display_columns>
96 This is the name of the table.
100 sub class_of { die "This is an abstract method" }
101 sub setup_database { die "This is an abstract method" }
102 sub fetch_objects { die "This is an abstract method" }
110 If there is an object in C<$r-E<gt>objects>, then it should be edited
111 with the parameters in C<$r-E<gt>params>; otherwise, a new object should
112 be created with those parameters, and put back into C<$r-E<gt>objects>.
113 The template should be changed to C<view>, or C<edit> if there were any
114 errors. A hash of errors will be passed to the template.
118 sub do_edit { die "This is an abstract method" }
122 The C<list> method should fill C<$r-E<gt>objects> with all of the
123 objects in the class. You may want to page this using C<Data::Page> or
139 sub list : Exported {
140 die "This is an abstract method";
143 sub view : Exported {
146 sub edit : Exported {
151 Also, see the exported commands in C<Maypole::Model::CDBI>.
153 =head1 Other overrides
155 Additionally, individual derived model classes may want to override the
158 =head2 display_columns
160 Returns a list of columns to display in the model. By default returns
161 all columns in alphabetical order. Override this in base classes to
162 change ordering, or elect not to show columns.
166 Same as display_columns, only for listings. Defaults to display_columns
170 Return a hash mapping column names with human-readable equivalents.
178 $col =~ s/_+(\w)?/ \U$1/g;
185 should return true if a certain action is supported, or false otherwise.
186 Defaults to checking if the sub has the C<:Exported> attribute.
192 my ($self, $action) = @_;
194 my %attrs = map {$_ => 1} $self->method_attrs($action);
196 return 1 if $attrs{Exported};
198 warn "$action not exported" if Maypole->debug;
205 Returns the list of attributes defined for a method. Maypole itself only
206 defines the C<Exported> attribute.
212 my ($class, $method) = @_;
214 my $cv = $class->can($method);
218 my @attrs = attributes::get($cv);
225 This can go either in the master model class or in the individual
226 classes, and returns a list of has-many accessors. A brewery has many
227 beers, so C<BeerDB::Brewery> needs to return C<beers>.