Aaron James Trevena > Maypole > Maypole::Config

Download:
Maypole-2.13.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  7
Open  5
View/Report Bugs
Module Version: 2.121   Source  

NAME ^

Maypole::Config - Maypole Configuration Class

DESCRIPTION ^

This class stores all configuration data for your Maypole application.

METHODS ^

View related

application_name

This should be a string containing your application's name.

Optional. Is used in the factory templates.

rows_per_page

This is the number of rows your application should display per page.

Optional.

tables

Contains a list of all tables, if supported by model.

template_extension

Optional template file extension.

template_root

This is where your application can find its templates.

uri_base

This is the URI base that should be prepended to your application when Maypole makes URLs.

view

The name of the view class for your Maypole Application. Defaults to "Maypole::View::TT".

build_form_elements

Globally specify whether to build form elements; populating the cgi metadata with autogenerated HTML::Element widgets for the class/object.

Can be over-ridden per action using the method of the same name for the request.

If not set, then Maypole will assume it is true.

view_options

A hash of configuration options for the view class. Consult the documentation for your chosen view class for information on available configuration options.

Model-Related

classes

This config variable contains a list of your view classes. This is set up by the model class, and should not be changed in the view or the config.

display_tables

This is a list of the tables that are public to your Maypole application. Defaults to all the tables in the database.

dsn

The DSN to your database. Follows standard DBD syntax.

loader

This is the loader object (n.b. an instance, not a class name). It's set up by the CDBI model to an instance of "Class::DBI::Loader" if it's not initialized before calling setup().

model

The name of the model class for your Maypole Application. Defaults to "Maypole::Model::CDBI".

ok_tables

This is a hash of the public tables. It is populated automatically by Maypole from the list in display_tables and should not be changed.

pass

Password for database user.

opts

Other options to the DBI connect call.

user

Username to log into the database with.

build_form_elements

Flag specifying whether to build metadata for form elements in factory templates

request_options

Hashref of options passed when creating cgi or apache request

Adding additional configuration data

You can use the 'additional' attribute for stashing additional info, especially from additional_data method, i.e. $r->config->additional({foo=>bar});

Or..

If your modules need to store additional configuration data for their own use or to make available to templates, add a line like this to your module:

   Maypole::Config->mk_accessors(qw(variable or variables));

Care is needed to avoid conflicting variable names.

SEE ALSO ^

Maypole

AUTHOR ^

Sebastian Riedel, sri@oook.de

AUTHOR EMERITUS ^

Simon Cozens, simon@cpan.org

LICENSE ^

You may distribute this code under the same terms as Perl itself.

syntax highlighting: