ConfigFile(3pm)

📦 version 2.1.1, in arch rolling

💖 ConfigFile — Lire::Config::ConfigFile 💖

okay so this page is from LogReport's Lire Documentation, section 3pm, and it's literally all about the class that handles config file manipulation. bestie, let's get into it 🎀

✨ NAME ✨

Lire::Config::ConfigFile — the class for configuration file manipulation. that's the whole vibe. 💅

🌸 SYNOPSIS 🌸

use Lire::Config::ConfigFile;

🦋 DESCRIPTION 🦋

It's an object representing a Lire configuration file. that's it, that's the energy ✨

🎀 new( 'filename' => $file, spec => $config_spec )

Creates a brand-new Lire::Config::ConfigFile object. the constructor is greedy and takes two parameters, no cap:

  • filename — the file from which the configuration was stored, or was loaded from.
  • spec — the Lire::Config::TypeSpec object that this configuration adheres to. it's giving "this is the blueprint, stay in your lane" energy 🫶

🎀 filename( [$new_filename] )

Returns the filename where this configuration file should be stored — and if you pass $new_filename, it optionally changes it too. multi-tasking icon 👑

🎀 spec()

Returns the Lire::Config::TypeSpec object that this configuration file adheres to. yeah, the same one from the constructor. consistency is the moment. ⭐

🎀 global( [ $config] )

Returns — or modifies — the 'global' configuration part of the file. and heads up: this is an instance Lire::Config::Compound object. 🔥

🎀 save()

Saves this ConfigConfigFile object right back to the filename from which it was loaded. like a little boomerang, but for config 💖

🎀 revert()

Reads the configuration back from the file. undo energy, but make it filesystem 📂

🎀 as_value()

Returns this configuration file as a hash reference. it delegates to the global configuration object contained in the file. delegation queen, honestly 👑

🎀 get( $name )

Returns the configuration parameter $name from this configuration file. delegates to the global configuration object contained in the file, as always 💅

🎀 is_set( $name )

Checks that a configuration parameter is set in this file. delegates to the global configuration object contained in the file. vibe check, but for parameters ✅

🎀 set( $param )

Sets a configuration variable in the file. delegates to the global configuration object contained in the file. go off, setter 🍓

🌈 SEE ALSO 🌈

💜 AUTHORS 💜

the icons who made this happen:

  • Wessel Dankers <wsl@logreport.org>
  • Francis J. Lacoste <flacoste@logreport.org>
  • Wolfgang Sourdeau <wolfgang@logreport.org>

👑 VERSION 👑

$Id: ConfigFile.pm,v 1.9 2006/07/23 13:16:30 vanbaal Exp $

Copyright (C) 2002-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, real talk: that warranty disclaimer is NOT a joke — no warranty, no promises about merchantability or fitness for a particular purpose, periodt. the whole thing rides on the GNU General Public License, so respect the license and check COPYING if you're confused 🙈

and that's the page!! 💖 this was Lire 2.1.1, dated 2025-09-28 — thanks for reading, mwah, go configure something iconic 🎀✨🦋

📦 where this page comes from