XMLSpecContainer(3pm)

📦 version 2.1.1, in arch rolling

💅 XMLSpecContainer — a.k.a. LogReport's Lire Documentation

okay so bestie, welcome to XMLSpecContainer(3pm) ✨ this is the vibe check for the base class that holds all the shared DNA. let's get into it 🫶

✨ NAME ✨

Lire::XMLSpecContainer — the base clase (yes, that's how the original spells it, we're keeping her) for XML report and filter specifications 🎀

🌸 SYNOPSIS 🌸

use base qw/Lire::XMLSpecContainer/;

literally that's it. one line and you're in the group chat 💅

🦋 DESCRIPTION 🦋

So this is the base class for Lire::ReportSpec and Lire::FilterSpec — the two XML specifications that get used to compute reports 👑

This man page documents the attributes that both types of specification have in common, so like… the shared braincell, the joint custody of methods 🧚

🍓 id( [ $new_id ] )

Returns the type id of this specification. If $new_id is set, it will change the id of the specification. simple as that 💖

🍓 superservice( [ $new_superservice ] )

Returns the superservice (aka base DLF schema) used by this specification. If $new_superservice is set, it will change the superservice of the specification 🌈

🍓 schema( [ $new_schema ] )

Returns the Lire::DLfSchema object used by this specification. This can be the superservice or any of its Lire::ExtendedSchema or Lire::DerivedSchema 👑

If $new_schema is a string, the specification's schema will be changed to that schema. If $new_schema is undef, the base DlfSchema (aka superservice) will be used. no cap 🫶

🍓 joined_schemas( [ $new_schemas ] )

Returns as an array reference, the list of schemas that are joined in this specification ✨

If $new_schemas is set, the list of joined schemas will be changed to that list. This is an array reference of schema name. All of these schemas should be join compatible with the schema specified in the schema() attribute — like, they gotta match energies, yk? 💅

🍓 schemas()

Returns in an array reference all the schemas used by this specification. This will include the base schema as well as any joined schemas — everybody accounted for, nobody left on read 💜

🍓 has_field( $name )

Returns whether the field named $name is available in this specification's schema or any of its joined schema 🔍

🍓 field( $name )

Returns the Lire::Field object named $name present in one of the specification's joined schema 🌸

🍓 title( [ $new_title ]

This method returns the title of this specification. If $new_title is set, the specification's title will be changed to that value 🎀

The returned value is localized if a translation string is available. The domain used for translation is 'lire-<superservice' ✨

🍓 description( [ $new_description ]

This method returns the description of this specification. If $new_description is set, the specification's description will be changed to that value. That description is a DocBook string describing the specification's purpose 📖

The returned value is localized if a translation string is available. The domain used for translation is 'lire-<superservice' ✨

🍓 display_title( [ $new_title ]

This method returns the title that will be displayed in the generated specification. This value can contains reference to the specification's parameters using the '$name' syntax 👀

If $new_title is set, the specification's display title will be changed to that value 💖

The returned value is localized if a translation string is available. The domain used for translation is 'lire-<superservice' ✨

🍓 display_description( [ $new_description ]

This method returns the description that will be displayed in the generated report. This value can contains reference to the specification's parameters using the '$name' syntax 👀

If $new_description is set, the specification's description will be changed to that value. That description is a DocBook string describing the specification's purpose 📖

The returned value is localized if a translation string is available. The domain used for translation is 'lire-<superservice' ✨

🍓 expanded_display_title()

Returns display_title() with parameters reference expanded 🔥

🍓 expanded_display_description()

Returns display_description() with parameters reference expanded 🔥

Prints this specification as XML on $fh 🖨️ — go off, serialize yourself, main character energy fr fr

👀 SEE ALSO 👀

💖 AUTHORS 💖

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

the literal icons who built this, we stan 🫶

⭐ VERSION ⭐

$Id: XMLSpecContainer.pm,v 1.41 2006/07/23 13:16:30 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 pls read the license, it's giving "I read the terms and conditions" energy but make it real 🙈

okay that's the whole page, mwah 💋 — this was Lire 2.1.1, dated 2025-09-28, page XMLSpecContainer(3pm). slay, go read Lire::ReportSpec(3pm) next, iykyk 💅✨

📦 where this page comes from