Perl::...ration(3pm)

📦
version 1.156.0 · 12 versions
, in opensuse-leap 16.0

Hii bestie 💖 welcome to the Perl::Critic::PolicyParameter::Behavior::Enumeration page — yep, the .3pm manual from the user-contributed Perl docs pile 💅. Buckle up, this one is short and slays.

🌸 NAME 🌸

Perl::Critic::PolicyParameter::Behavior::Enumeration — Actions appropriate for an enumerated value. Periodt.

✨ DESCRIPTION ✨

It provides a standard set of functionality for an enumerated Perl::Critic::PolicyParameter, so the developer of a policy does not have to provide it her/himself. Iconic.

🚨 NOTE, bestie: Do not instantiate this class. Use the singleton instance held onto by Perl::Critic::PolicyParameter. That’s the whole vibe. Don’t try to make your own.

🦋 INTERFACE SUPPORT 🦋

Okay so important: this is considered to be a non-public class. Its interface is subject to change without notice. Not me warning you 😭. Treat it like a backstage pass, not a stable public API.

🔥 METHODS 🔥

💖 initialize_parameter( $parameter, $specification ) 💖

Plug in the functionality this behavior provides into the parameter, based upon the configuration provided by the specification. Basically it wires the behavior into $parameter using whatever $specification says.

This behavior looks for two configuration items:

  • enumeration_values — Mandatory. The set of valid values for the parameter, as an array reference. No cap, you gotta give it the list.
  • enumeration_allow_multiple_values — Optional, defaults to false. Should the parameter support a single value or accept multiple? That’s the question 💅.

💖 generate_parameter_description( $parameter ) 💖

Create a description of the parameter, based upon the description on the parameter itself, but enhancing it with information from this behavior.

In this specific case, the universe of values is added at the end. Cute little bonus lore at the end of the description ✨.

👑 AUTHOR 👑

Elliot Shank <perl@galumph.com> — the icon behind this one 🫶.

Copyright (c) 2006-2023 Elliot Shank.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of this license can be found in the LICENSE file included with this module.

That’s the legal tea, bestie — keep it exactly as it is 🍓.

Byeee 🫶 this page rode in with perl v5.42.0 and is dated 2024-10-23; the footer also calls it Perl::...ration(3pm) 😭💖

📦 where this page comes from