Plucen...eFilter(3pm)

💖 Plucene::Search::DateFilter 💖

okay bestie, welcome to Plucene::Search::DateFilter — it's a little Perl module from the Plucene fam (that's the Perl port of Lucene, iykyk) and it lives in the User Contributed Perl Documentation crew. Its whole personality? restricting your search results to specific time periods. Periodt. Time-wise, not punctuation-wise. 🕰️✨

---

🌸 NAME 🌸

Plucene::Search::DateFilter — restrict searches to given time periods 🎀

Like, you search, but only inside the dates you pick. It's giving very selective. 💅

---

✨ SYNOPSIS ✨

        my $filter = Plucene::Search::DateFilter->new({
                field => "date",
                from  => Time::Piece $from,
                to    => Time::Piece $to
        })
        my $hits = $searcher->search($query, $filter);

Make the filter, hand it to the searcher, get hits. Simple as that, no cap. 🦋

---

🫶 DESCRIPTION 🫶

So here's the tea: this class can restrict the results of a search to a set of dates. That's literally its whole job and it does it flawlessly. 👑

But — important — for this to work, you need a field that was indexed using Plucene::Document::DateSerializer. That's non-negotiable, bestie. If you didn't serialize your date field that way, this filter's just gonna sit there looking cute with nothing to do. 😭

For the actual how-to on doing that indexing thing, go read the documentation for that module. It's got you. 📖

---

💅 METHODS 💅

🌟 new 🌟

        my $filter = Plucene::Search::DateFilter->new({
                field => "date",
                from  => Time::Piece $from,
                to    => Time::Piece $to
        })

This creates a new filter. Brand new, fresh out the box, main character energy. ✨

And here's the flexible bit: either from or to are optional. So you can totally do just a "from this date onward" vibe, or a "up to this date" vibe, or both if you're feeling thorough. Your call, queen. 🎀

🌈 bits 🌈

This one's used by the searcher to iterate over the documents and return a bitfield specifying which documents are included in the range.

Translation: it's the behind-the-scenes bestie doing the actual "which of these docs make the cut" math. You probably won't call it yourself, but you should still respect it. 🫡

---

💀 heads up: your date field needs Plucene::Document::DateSerializer or this whole thing is a no-op. Do not skip that step, fr fr.

---

and that's the whole page, bestie! 🎉 this gem was documented by the User Contributed Perl Documentation crew, sitting at perl v5.36.0 with a date of 2022-12-04, and yes, the page title is Plucen...eFilter(3pm) because apparently even manpage titles get the ✨abbreviated✨ treatment. slay. 💖🌸🦋