Param(3pm)

📦 version 2.1.1, in arch rolling

💅 Lire::Param — the manual page, but make it make sense

okay so bestie, welcome to Param(3pm) from LogReport's Lire documentation ✨ this is the whole vibe on Lire::Param and honestly it's giving "small object, big responsibilities" 🎀

🌸 NAME

Lire::Param — the object that represents a parameter inside an XML specification. periodt 💖

🦋 DESCRIPTION

so Lire::Param objects are literally the lil guys that represent parameters in an XML specification 💫 and here's the slay part: the object pulls double duty — it holds the parameter's specification and its current value at the same time. main character energy fr fr 👑

✨ new( 'name' => $name, 'type' => $type, [ 'default' => $default ] )

creates a brand new Lire::Param object 🫶 that's it, that's the constructor, she's simple and she works.

✨ name()

returns the name of this parameter — like, what is she called 💅

✨ type()

returns this parameter's type 🌈

✨ value( [ $new_value ] )

returns the current value for this parameter, and optionally modifies it if you pass $new_value 🔥 and here's the cute detail: if no value was ever set, but a default is available, the default value gets returned instead 💖

✨ default( [ $new_default ] )

returns the parameter's default value — and again, optionally changes it if you hand it $new_default 🌸

✨ description( [ $new_description ] )

returns the current parameter's description, and optionally changes it when you pass $new_description 🎀

✨ as_type_spec()

returns a Lire::Config::TypeSpec object that adequately represents the current parameter 👑 like it takes the param and gives you the type-spec version, iconic behavior honestly.

🌟 SEE ALSO

go read those too bestie, iykyk 🦋

🧚 AUTHOR

Francis J. Lacoste <flacoste@logreport.org> 💌

⭐ VERSION

$Id: Param.pm,v 1.13 2006/07/23 13:16:29 vanbaal Exp $

Copyright (C) 2001,2004 Stichting LogReport Foundation LogReport@LogReport.org

This file is part of Lire.

Lire is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program (see COPYING); if not, check with http://www.gnu.org/copyleft/gpl.html.

bestie this is the legal bit — don't skip it, it's literally the license 🫶

okay that's the whole page!! shipped with Lire 2.1.1, dated 2025-09-28, and it's Param(3pm) — mwah, go forth and parameter responsibly 💅💖✨

📦 where this page comes from