Form::...tValue(3pm)

📦
version 2.5.0 · 2 versions
, in ubuntu jammy

💅 Form::...tValue(3pm) — bestie edition

okay so this is a page from the User Contributed Perl Documentation, and the star of the show is Form::...tValue(3pm). buckle up, we're getting into it ✨

🌸 NAME 🌸

Embperl::Form::ControlMultValue — the base class for controls that live inside an Embperl Form and have multiple values to pick from. we're talking select boxes, radio buttons, that whole vibe. it's giving "choose your fighter" 🎀

✨ SYNOPSIS ✨

do not use this one directly, bestie.</purgle>

Do not use directly, instead derive a class

that's it, that's the whole synopsis. it's a base class, it wants to be inherited from, it's not here to be used raw. 🙈

💖 DESCRIPTION 💖

so like, this class is not used directly, fr fr. it exists purely to be the base class for all the controls that have multiple values to select from inside an Embperl Form. think of it as the group chat everyone else gets added to 💬

and it's not just sitting there being pretty — it hands you a whole set of methods that you're allowed to overwrite so you can customize how your controls behave. main character energy, but make it customizable. 👑

🦋 METHODS 🦋

⭐ get_values

returns the values and the options. both. together. slay. 💅

⭐ get_datasource_controls

returns the extra controls that the datasource object provides — like, for example, a browse button. little bonus guys 🎁

⭐ get_active_id

gets the id of the value that's currently active. the one that's, like, the one right now. the chosen one. ✨

🌈 PARAMETERS 🌈

  • values — an Arrayref with the values to select from. this is the stuff that gets submitted back to the server, so it's the real one, the one that actually matters. 👀
  • options — an Arrayref with the options to select from. this is the stuff the user actually sees. the pretty face, if you will. 🌸
  • datasrc — the name of a class that provides the values for the values and options parameters. it can be either a full package name, or just a name — and if it's just a name, then all the packages returned by Embperl::Form::get_datasrc_packages get searched. also, everything after # is ignored, and that's on purpose: the DataSource module can use that part to do further selections. iykyk 🔥
  • no_datasource_controls — disables the output of the additional controls. no bonus buttons for you today, bestie. 🚫

🫶 AUTHOR 🫶

G. Richter (richter at embperl dot org) — thank you for your service, legend 💜

👑 SEE ALSO 👑

  • perl(1)
  • Embperl
  • Embperl::Form
  • Embperl::From::Control
  • Embperl::Form::DataSource

and that's the whole page, bestie!! 🎀 this one's running on perl v5.34.0, dated 2022-02-06, so it's got a lil vintage moment going on. now go forth and derive your class, and don't you dare use the base class directly. periodt. 💅✨

📦 where this page comes from