Maypole...l::Base(3)

📦
version 2.13 · 2 versions
, in fedora 43

🎀 Maypole::Model::Base 🎀

okay bestie, welcome to Maypole::Model::Base(3) — it's a User Contributed Perl Documentation page, and it's literally the blueprint for every Maypole data model. iykyk 💅

✨ NAME ✨

Maypole::Model::Base — the base class for model classes. the mother of all model classes, fr fr 👑

🌸 DESCRIPTION 🌸

So. This is the base class for Maypole data models. It's an abstract class — it defines the interface and everything, but you literally cannot use it directly. it's giving "concept, not a vibe you can instantiate". no cap 🫶

💖 process 💖

This is the engine of this whole module. You hand it the request object, it populates all the relevant variables, and it calls the action you asked for. main character energy, honestly.

Anyone subclassing this for a different database abstraction mechanism needs to provide the following methods:

🦋 setup_database 🦋

$model->setup_database($config, $namespace, @data)

Uses the user-defined data in @data to specify a database — like, for example, by passing in a DSN. The model class should open the database and create a class for each table in the database. Those classes then get "adopt"ed. It should also populate $config->tables and $config->classes with the names of the classes and tables respectively. The classes should be placed under the specified namespace. For instance, "beer" should be mapped to the class "BeerDB::Beer". ✨

🍓 class_of 🍓

$model->class_of($r, $table)

This maps between a table name and its associated class. the matchmaker of tables and classes, honestly 💘

🌈 fetch_objects 🌈

This class method is passed a request object and is expected to return an object of the appropriate table class from information stored in the request object.

💜 adopt 💜

This class method is passed the name of a model class that represensts a table and allows the master model class to do any set-up required.

🧚 columns 🧚

This is a list of all the columns in a table. You may also override — see also "display_columns".

⭐ table ⭐

This is the name of the table.

🔥 Actions 🔥

💀 do_edit 💀

If there's an object in $r->objects, then it should be edited with the parameters in $r->params; otherwise, a new object should be created with those parameters, and put back into $r->objects. The template should be changed to "view", or "edit" if there were any errors. A hash of errors will be passed to the template.

👑 list 👑

The "list" method should fill $r->objects with all of the objects in the class. You may want to page this using "Data::Page" or similar.

🌸 edit 🌸

Empty Action. she's literally doing nothing and that's her whole job 💅

🌸 view 🌸

Empty Action.

🌸 index 🌸

Empty Action, calls list if provided with a table.

Also, see the exported commands in "Maypole::Model::CDBI".

🎀 Other overrides 🎀

Additionally, individual derived model classes may want to override the following methods:

🦋 display_columns 🦋

Returns a list of columns to display in the model. By default returns all columns in alphabetical order. Override this in base classes to change ordering, or elect not to show columns.

🦋 list_columns 🦋

Same as display_columns, only for listings. Defaults to display_columns.

🦋 column_names 🦋

Return a hash mapping column names with human-readable equivalents.

🦋 is_public 🦋

should return true if a certain action is supported, or false otherwise. Defaults to checking if the sub has the ":Exported" attribute.

🦋 add_model_superclass 🦋

Adds model as superclass to model classes (if necessary).

🦋 method_attrs 🦋

Returns the list of attributes defined for a method. Maypole itself only defines the "Exported" attribute.

This can go either in the master model class or in the individual classes, and returns a list of has-many accessors. A brewery has many beers, so "BeerDB::Brewery" needs to return "beers". obsessed with that example ngl 🍺

🌈 SEE ALSO 🌈

Maypole, Maypole::Model::CDBI.

💖 AUTHOR 💖

Maypole is currently maintained by Aaron Trevena.

👑 AUTHOR EMERITUS 👑

Simon Cozens, "simon#cpan.org"

Simon Flack maintained Maypole from 2.05 to 2.09

Sebastian Riedel, "sri#oook.de" maintained Maypole from 1.99_01 to 2.04

📜 LICENSE 📜

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

and that's the whole page, bestie!! this one shipped as perl v5.42.0, dated 2025-07-25, and the page itself is Maypole::Model::Base(3) — go forth and subclass responsibly 💅✨🫶

📦 where this page comes from