]> git.decadent.org.uk Git - maypole.git/blobdiff - lib/Maypole/Config.pm
Use Class::Accessor::Fast;
[maypole.git] / lib / Maypole / Config.pm
index b8202cf4d4b49260faf97418477809742265a23c..b48548efa6d0251dd750c98a85bd8d502eef8c44 100644 (file)
@@ -1,8 +1,7 @@
 package Maypole::Config;
-use base qw(Class::Accessor);
+use base qw(Class::Accessor::Fast);
 use attributes ();
-#use overload
-#    '""' => sub { shift->stringify_self};
+
 use strict;
 use warnings;
 
@@ -10,14 +9,13 @@ use warnings;
 __PACKAGE__->mk_accessors(
     qw( view uri_base template_root model loader display_tables ok_tables
       rows_per_page dsn user pass opts)
-      );
+);
 
 # Should only be modified by model.
-    __PACKAGE__->mk_ro_accessors( qw(
-         classes
-         tables
-         table_to_class
-    ) );
+__PACKAGE__->mk_ro_accessors(
+    qw( classes tables table_to_class
+      )
+);
 
 1;
 
@@ -29,32 +27,85 @@ Maypole::Config - Maypole Configuration Class
 
 This class stores all configuration data for your Maypole application.
 
-=head2 view
+=head1 METHODS
+
+=head2 View related
+
+=head3 view
 
 The view class for your Maypole Application. Defaults to "Maypole::View::TT"
 
-=head2 display_tables 
+=head3 uri_base 
+
+This is the uri base that should be appended to your application when maypole 
+makes urls.
+
+=head3 template_root
+
+This is where your application can find it's templates.
+
+=head3 rows_per_page
+
+This is the  number of rows your application should display per page.
+
+=head2 Model-Related
+
+=head3 display_tables 
+
+These are the tables that are public to your maypole application
+
+=head3 ok_tables
+
+These are the tables that maypole should care about
+
+=head3 model
+
+The model class for your Maypole Application. Defaults to "Maypole::View::CDBI"
+
+=head3 loader
+
+This is the loader object. It's set up by the CDBI model if it's not initialized before setup.
+
+=head3 classes
+
+This config variable contains a list of your view classes. This set up by the
+model class, and should not be changed in the view or the config.
+
+=head3 dsn
+The DSN to your database. Follows standard DBD syntax.
+
+=head3 user
+
+Username to log into the database with
+
+=head3 pass
+
+Password for database user.
+
+=head3 opts
+
+Other options to the dbi connect call.
+
+=head1 SEE ALSO
 
-=head2 ok_tables
+L<Maypole>
 
-=head2 model
+=head1 MAINTAINER
 
-=head2 loader
+Sebastian Riedel, c<sri@oook.de>
 
-=head2 uri_base 
+=head1 AUTHOR
 
-=head2 classes
-=head2 rows_per_page
+Simon Cozens, C<simon@cpan.org>
 
-=head2 dsn
+=head1 THANK YOU
 
-=head2 user
+Jesse Scheidlower, Jody Belka, Markus Ramberg, Mickael Joanne, Simon Flack,
+Veljko Vidovic and all the others who've helped.
 
-=head2 pass
+=head1 LICENSE
 
-=head2 opts
+You may distribute this code under the same terms as Perl itself.
 
-+head2 table_to_root
+=cut
 
-=head2 template_root