Index(3pm)

📦 version 2.1.1, in arch rolling

🌸 Lire::Config::Index — the Index(3pm) page, bestie 🌸

💖 NAME 💖

Lire::Config::Index — Index registry and interface. That's the whole name, no cap.

✨ SYNOPSIS ✨

use base qw/Lire::Config::Index/;

sub has_entry { my ($self, $name) = @_; ... }

sub entries { my $self = $_[0]; ... }

sub get_ref { my ($self, $name) = @_; ... }

🦋 DESCRIPTION 🦋

The Lire::Config::Index interface is used by the Lire::Config::ReferenceSpec(3pm) to validate and obtain referenced object. Yes, that's the vibe: it's the little registry bestie that helps references get checked and fetched. 💅

🗂️ INDEX REGISTRY 🗂️

These are the class methods used to register and obtain Index objects.

has_index( $name )

Returns true if an index was registered under $name.

get_index( $name )

Returns the Index named $name — and yes, the page literally spells it Retuurns, so we're keeping that icon behavior. 😭 Croaks if no such index was registered.

set_index( $name, $index )

Registers $index under $name. Replaces any previous index registered under the same name. Out with the old, in with the new, periodt. ✨

🪪 INDEX INTERFACE 🪪

has_entry( $name )

Should return true if $name is defined in this index.

entries()

Should return all the entries defined in the index.

get_ref( $name )

Should return the object indexed under $name. An error should be thrown if there is no such entry.;. — and yes, that punctuation is literally doing its own thing, bestie 💀.

🔗 SEE ALSO 🔗

👑 AUTHOR 👑

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

⭐ VERSION ⭐

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

Copyright (C) 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.

Okay that's the whole page, bestie. No missing flags, no skipped license lore, no cap. 💖

Lire 2.1.1 · 2025-09-28 · Index(3pm) — mwah, bye! 🧚💜

📦 where this page comes from