1 package Maypole::Config;
2 use base qw(Class::Accessor::Fast);
8 our $VERSION = "1." . sprintf "%04d", q$Rev$ =~ /: (\d+)/;
11 __PACKAGE__->mk_accessors(
12 qw( view view_options uri_base template_root model loader display_tables
13 ok_tables rows_per_page dsn user pass opts application_name)
16 # Should only be modified by model.
17 __PACKAGE__->mk_ro_accessors(qw( classes tables));
23 Maypole::Config - Maypole Configuration Class
27 This class stores all configuration data for your Maypole application.
33 =head3 application_name
35 This should be a string containing your application's name.
37 Optional. Is used in the factory templates.
41 This is the number of rows your application should display per page.
47 Contains a list of all tables, if supported by model.
51 This is where your application can find its templates.
55 This is the URI base that should be prepended to your application when Maypole
60 The name of the view class for your Maypole Application. Defaults to
65 A hash of configuration options for the view class. Consult the documentation
66 for your chosen view class for information on available configuration options.
72 This config variable contains a list of your view classes. This is set
74 model class, and should not be changed in the view or the config.
78 This is a list of the tables that are public to your Maypole
79 application. Defaults to all the tables in the database.
83 The DSN to your database. Follows standard DBD syntax.
87 This is the loader object (n.b. an instance, not a class name). It's set
88 up by the CDBI model to an instance of "Class::DBI::Loader" if it's not
89 initialized before calling setup().
93 The name of the model class for your Maypole Application. Defaults to
94 "Maypole::Model::CDBI".
98 This is a hash of the public tables. It is populated automatically by
99 Maypole from the list in display_tables and should not be changed.
103 Password for database user.
107 Other options to the DBI connect call.
111 Username to log into the database with.
113 =head2 Adding additional configuration data
115 If your modules need to store additional configuration data for their
116 own use or to make available to templates, add a line like this to your
119 Maypole::Config->mk_accessors(qw(variable or variables));
121 Care is needed to avoid conflicting variable names.
129 Sebastian Riedel, C<sri@oook.de>
131 =head1 AUTHOR EMERITUS
133 Simon Cozens, C<simon@cpan.org>
137 You may distribute this code under the same terms as Perl itself.