Plugin(3pm)

📦 version 2.1.1, in arch rolling

🌸 NAME 🌸

Lire::Plugin is the base interface of all Lire plugins, bestie. This is the Plugin(3pm) page from LogReport's Lire Documentation, and it's basically the blueprint every plugin class is built on. 💅

✨ SYNOPSIS ✨

  use base qw/ Lire::Plugin /;

💖 DESCRIPTION 💖

Okay so this package defines the base interface implemented by all plugins. That's the whole vibe: if you're a Lire plugin, this is the interface you're implementing — lowkey the main character energy of the whole plugin system. No cap. 🫶

🎀 DEFAULT CONSTRUCTOR 🎀

The plugin class has a new() constructor which blesses an hash reference. That's it. That's the constructor. Lowkey iconic. ✨

🌸 name() 🌸

Returns the name of the plugin. Simple, iconic, does exactly what it says. 💖

🦋 title() 🦋

Returns a more human friendly name for the plugin. So like the cute display name, not just the internal one. Obsessed. 💅

🎀 description() 🎀

Returns a DocBook XML based documentation of the plugin. Yes, DocBook XML — it's giving very structured, very official. DocBook ate, honestly. 📜

👑 type 👑

Returns the type of plugin. The page says there are three plugin types in Lire, and then lists four, so make of that what you will, bestie 😭💀. Here they are, fr fr:

  • dlf_converter — these plugins are used to converter log files to DLF. The plugin will also need to implement the Lire::DlfConverter interface. 🔥
  • output_format — these plugins are used to format XML reports. A plugin of this type should implement the Lire::OutputFormat interface. 🎀
  • dlf_analyser — these plugins are used to generate other DLF records from existing Dlf records. They should implement the Lire::Analaser interface. (Spelled exactly like that on the page — I'm not fixing it, I'm just delivering the facts 🙈)
  • chart_type — these plugins are used to generate charts. 📊

👀 SEE ALSO 👀

💜 AUTHOR 💜

Francis J. Lacoste <flacoste@logreport.org> — legend behavior, honestly. 👑

⭐ VERSION ⭐

$Id: Plugin.pm,v 1.5 2006/07/23 13:16:29 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.

Later bestie! This page came from LogReport's Lire Documentation, Lire 2.1.1, dated 2025-09-28. Mwah 💋✨

📦 where this page comes from