1 package Maypole::Model::Base;
3 sub MODIFY_CODE_ATTRIBUTES { $remember{$_[1]} = $_[2]; () }
5 sub FETCH_CODE_ATTRIBUTES { $remember{$_[1]} }
11 my $method = $r->action;
12 $r->{template} ||= $method; # Authentication may have done this for us
13 $r->objects([ $class->retrieve(shift @{$r->{args}}) ]);
15 # This allows the authentication mechanism to set the template
16 # without needing to define an action.
17 $class->$method($r) if $class->can($method);
26 Maypole::Model::Base - Base class for model classes
30 Anyone subclassing this for a different database abstraction mechanism
31 needs to provide the following methods:
35 If there is an object in C<$r-E<gt>objects>, then it should be edited
36 with the parameters in C<$r-E<gt>params>; otherwise, a new object should
37 be created with those parameters, and put back into C<$r-E<gt>objects>.
38 The template should be changed to C<view>, or C<edit> if there were any
39 errors. A hash of errors will be passed to the template.
43 sub do_edit { die "This is an abstract method" }
47 $model->setup_database($config, $namespace, @data)
49 Uses the user-defined data in C<@data> to specify a database- for
50 example, by passing in a DSN. The model class should open the database,
51 and create a class for each table in the database. These classes will
52 then be C<adopt>ed. It should also populate C<< $config->{tables} >> and
53 C<< $config->{classes} >> with the names of the classes and tables
54 respectively. The classes should be placed under the specified
55 namespace. For instance, C<beer> should be mapped to the class
60 $model->class_of($r, $table)
62 This maps between a table name and its associated class.
66 This turns an ID into an object of the appropriate class.
70 This is called on an model class representing a table and allows the
71 master model class to do any set-up required.
75 This can go either in the master model class or in the individual
76 classes, and returns a list of has-many accessors. A brewery has many
77 beers, so C<BeerDB::Brewery> needs to return C<beers>.
81 This is a list of all the columns in a table. You may also override
82 C<display_columns>, which is the list of columns you want to view, in
87 This is the name of the table.
95 The C<list> method should fill C<< $r-> objects >> with all of the
96 objects in the class. You may want to page this using C<Data::Page> or
103 sub class_of { die "This is an abstract method" }
104 sub setup_database { die "This is an abstract method" }
105 sub list :Exported { die "This is an abstract method" };
109 Also, see the exported commands in C<Maypole::Model::CDBI>.
111 =head1 Other overrides
113 Additionally, individual derived model classes may want to override the
118 Return a hash mapping column names with human-readable equivalents.
122 sub column_names { my $class = shift; map {
124 $col =~ s/_+(\w)?/ \U\1/g;
125 $_ => ucfirst $col } $class->columns }
129 A description of the class to be passed to the template.
133 sub description { "A poorly defined class" }