Maypole::Config(3)

📦
version 2.13 · 2 versions
, in fedora 43

💖 Maypole::Config 💖

okay bestie, gather round, because this is the Maypole Configuration Class, and it's from the User Contributed Perl Documentation crew. It's literally the ✨config page✨ for your whole Maypole app. Let's go.

🌸 NAME 🌸

Maypole::Config — Maypole Configuration Class. that's it, that's the name, slay. 👑

🦋 DESCRIPTION 🦋

This class stores all the configuration data for your Maypole application. every single setting. it's the group chat where all your app's little preferences live, and everyone reads from it. periodt. 💅

✨ METHODS ✨

  • application_name — should be a string with your application's name in it. it's Optional, and it gets used in the factory templates. cute, right? 🌸
  • rows_per_page — the number of rows your application should display per page. also Optional. go off, pagination. 🍓
  • tables — contains a list of all the tables, if your model supports that. iykyk. 💜
  • template_extension — Optional template file extension. yeah, just that. iconic. ✨
  • template_root — this is where your application can find its templates. home sweet home for your .tt files. 🏠
  • uri_base — the URI base that should be prepended to your application whenever Maypole makes URLs. don't forget it, bestie. 🔥
  • 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 — like, populating the cgi metadata with autogenerated HTML::Element widgets for the class/object. it Can be over-ridden per action using the method of the same name for the request. and If not set, then Maypole will assume it is true. so like, the default vibe is yes. ✅
  • view_options — a hash of configuration options for the view class. consult the documentation for your chosen view class to find out what configuration options are even available, because that's class-dependent, no cap. 📚
  • classes — this config variable contains a list of your view classes. it's set up by the model class, and you should not change it in the view or the config. hands off, bestie. 🙈
  • display_tables — a list of the tables that are public to your Maypole application. defaults to all the tables in the database. the whole menu. 🍽️
  • 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(). important distinction, don't come for me. ⭐
  • model — the name of the model class for your Maypole Application. defaults to "Maypole::Model::CDBI". 👑
  • ok_tables — a hash of the public tables. it is populated automatically by Maypole from the list in display_tables and should not be changed. seriously, leave it alone. 💀
  • pass — password for database user. shhh. 🤫
  • opts — other options to the DBI connect call. the extras. 🌈
  • user — username to log into the database with. hi hello. 👋
  • build_form_elements — flag specifying whether to build metadata for form elements in factory templates. yep, this one shows up again down here in the model section, and it's got its own separate description. both are real, both stay. 💖
  • 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 the additional_data method, like this:

$r->config->additional({foo=>bar});

Or..

If your modules need to store additional configuration data for their own use, or to make it 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. no stepping on each other's toes in the config, bestie, that's the rule. 😭

🔥 SEE ALSO 🔥

  • Maypole — the main character. go read that one too. 💜

👑 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. periodt. 🫶

and that's the whole page, bestie!! ✨ this gem came to you from perl v5.42.0, dated 2025-07-25 — mwah, love that for us, see you in the next manpage 💖🎀🦋

📦 where this page comes from