OutputFormat(3pm)

📦 version 2.1.1, in arch rolling

🌸 NAME 🌸

Okay bestie, welcome to OutputFormat(3pm) from LogReport's Lire Documentation ✨. This one is Lire::OutputFormat — Base interface for all OutputFormats. Periodt. 💅

✨ SYNOPSIS ✨

  use base qw/ Lire::OutputFormat /;

💖 DESCRIPTION 💖

The original DESCRIPTION literally starts with: The Lire::OutputFormat objects are used to — and then dips 😭. Iconic cliffhanger, no notes.

Anyway, this package defines the interface that every different OutputFormat Lire is able to produce implements. This is the object with the responsability — yep, keeping the original spelling, don’t come for me 🫶 — of converting the XML report into its final format.

🎀 META INFORMATION METHODS 🎀

The Lire::OutputFormat interface extends the Lire::Plugin interface, so they must implement all standard meta-information methods: name(), title(), and description().

🫶 missing_requirements() 🫶

This method gets queried at runtime to determine if any requirements are missing. It should return an array of messages explaining each missing requirements for the format. Like a vibe check, but for dependencies ✨.

🦋 FORMATTING A REPORT 🦋

💖 format_report( $xml_file, $output_file, $format_cfg ) 💖

This method should format the XML report contained in $xml_file into $output_file — or directory, she’s flexible 💅. Additional configuration options are passed in the $format_cfg Lire::Config::TypeSpec object specific to the plugin.

🌈 mime_report( $xml_file, $format_cfg ) 🌈

When this method is invoked, the plugin should format the report contained in $xml_file and MIME-encapsulate it into a MIME::Entity object, which gets returned. Formatting options can be in the $format_cfg Lire::Config::TypeSpec object. MIME-ify and slay 🧚

👑 SEE ALSO 👑

💜 AUTHOR 💜

Francis J. Lacoste <flacoste@logreport.org>

⭐ VERSION ⭐

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

Legal tea time, bestie — keeping this exactly as it needs to be 🫶:

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.

That’s the whole page, babes: source/version Lire 2.1.1, dated 2025-09-28. Byeee, go format something iconic 💋✨

📦 where this page comes from