1 package Maypole::Model::Base;
3 sub MODIFY_CODE_ATTRIBUTES { $remember{$_[1]} = $_[2]; () }
5 sub FETCH_CODE_ATTRIBUTES { $remember{$_[1]} }
11 $r->template( my $method = $r->action );
12 $r->objects([ $class->retrieve(shift @{$r->{args}}) ]);
22 Maypole::Model::Base - Base class for model classes
26 Anyone subclassing this for a different database abstraction mechanism
27 needs to provide the following methods:
31 If there is an object in C<$r-E<gt>objects>, then it should be edited
32 with the parameters in C<$r-E<gt>params>; otherwise, a new object should
33 be created with those parameters, and put back into C<$r-E<gt>objects>.
34 The template should be changed to C<view>, or C<edit> if there were any
35 errors. A hash of errors will be passed to the template.
39 sub do_edit { die "This is an abstract method" }
43 $model->setup_database($config, $namespace, @data)
45 Uses the user-defined data in C<@data> to specify a database- for
46 example, by passing in a DSN. The model class should open the database,
47 and create a class for each table in the database. These classes will
48 then be C<adopt>ed. It should also populate C<< $config->{tables} >> and
49 C<< $config->{classes} >> with the names of the classes and tables
50 respectively. The classes should be placed under the specified
51 namespace. For instance, C<beer> should be mapped to the class
56 $model->class_of($r, $table)
58 This maps between a table name and its associated class.
62 This turns an ID into an object of the appropriate class.
66 This is called on an model class representing a table and allows the
67 master model class to do any set-up required.
71 This can go either in the master model class or in the individual
72 classes, and returns a list of has-many accessors. A brewery has many
73 beers, so C<BeerDB::Brewery> needs to return C<beers>.
77 This is a list of all the columns in a table. You may also override
78 C<display_columns>, which is the list of columns you want to view, in
83 This is the name of the table.
91 The C<list> method should fill C<< $r-> objects >> with all of the
92 objects in the class. You may want to page this using C<Data::Page> or
99 sub class_of { die "This is an abstract method" }
100 sub setup_database { die "This is an abstract method" }
101 sub list :Exported { die "This is an abstract method" };
105 Also, see the exported commands in C<Maypole::Model::CDBI>.
107 =head1 Other overrides
109 Additionally, individual derived model classes may want to override the
114 Return a hash mapping column names with human-readable equivalents.
118 sub column_names { my $class = shift; map { $_ => ucfirst $_ } $class->columns }
122 A description of the class to be passed to the template.
126 sub description { "A poorly defined class" }