Timeslot(3pm)

📦 version 2.1.1, in arch rolling

💅 Timeslot(3pm) — bestie edition

okay so this is a page straight outta LogReport's Lire Documentation, and it's about Lire::Timegroup, which — minor plot twist — lives in the Timeslot page. don't ask, it's canon 🎀

✨ NAME ✨

Lire::Timegroup — the base class for implementations of the timeslot aggregator. it's giving "parent energy", the blueprint other things build on 🫶

✨ SYNOPSIS ✨

use Lire::Timeslot;

✨ DESCRIPTION ✨

so this module is literally the base class for implementing the timeslot aggregator, no cap. and what does that aggregator do? it splits up the DLF records based on a unit of time. 🕰️

like, say your unit is 1h — then every single DLF record that happens on the same hour of day gets grouped together, independently of which day it happens on. the day? irrelevant. the hour? main character. ✨

🦋 CONSTRUCTOR 🦋

new( %params )

creates a shiny new instance of a timegroup aggregator. 💖 and on top of the normal report operator parameters, the timegroup aggregator can also take these:

  • field — this optional parameter holds the DLF field containing the time value that's used to group the DLF records together. wanna know more? go peek at the field() method. 👀
  • unit — this one is mandatory, bestie, you can't skip it. it should contain the time unit used to group the records. details live in the unit() method. 🔥

🌸 METHODS 🌸

field( [$new_field] )

returns the name of the DLF field that's being used to group the DLF records. it should be a valid timestamp DLF field in the current schema — that part's non-negotiable. by default, the default timestamp field of the DLF schema gets used. 🎀

and yeah, you can change the field whenever you want by passing in a $new_field parameter. slay.

unit( [$new_unit])

returns the time unit that'll be used to group the DLF records. 🕐 the unit is expressed as a duration value — like 1s — but here's the tea: this groups the records based on the second unit of the DLF record's timestamp value. periodt. 📌

it could also be the name of a report specification's parameter that contains a duration value. iykyk.

the time unit can be swapped out by using the $new_unit parameter. 💫

👑 SEE ALSO 👑

so like, go read these too, fr fr:

💜 AUTHORS 💜

the icons who made this happen:

 Francis J. Lacoste <flacoste@logreport.org>
 Wolfgang Sourdeau <Wolfgang.Sourdeau@Contre.COM>

⭐ VERSION ⭐

 $Id: Timeslot.pm,v 1.27 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 — not even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 😭 (dramatic but true, that's just how the GPL do.) 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. 🧚

ngl the whole "no warranty" thing is a real vibe check — read it, it matters 💀

okay that's the whole page, bye bestie! 🦋 this was Lire 2.1.1, dated 2025-09-28 — stamped, sealed, delivered, and absolutely iconic. 💅✨

📦 where this page comes from