Search...::Class(3pm)

💖 Search...::Class — the perl manual page, bestie edition 💖

okay so this is a page from the User Contributed Perl Documentation (yes that's the manual name, and yes it's giving ✨official✨). It's Search...::Class(3pm) and it's about making class-based GIN queries. Stay with me, it's cute, I promise. 🫶

---

✨ NAME ✨

Search::GIN::Query::Class — Create class-based GIN queries. that's it, that's the whole name section, and honestly? iconic. 💅

---

🌸 VERSION 🌸

version 0.11 — that's the version, no cap.

---

🎀 SYNOPSIS 🎀

here's the vibe, copy-paste ready:

use Search::GIN::Query::Class;

my $query = Search::GIN::Query::Class->new(
    class => 'Person',
);

look at her. four lines. a queen. 👑

---

🦋 DESCRIPTION 🦋

So what does this actually do, bestie? It creates a class-based GIN query that can be used to search records in a storage. fr fr, that's the whole job.

It's a ready-to-use query — like, no assembly required — and it uses class definitions to search through the storage. Specifically, it uses class, does and blessed to do the searching. those three are the main characters here. 🌈

---

💜 METHODS/SUBROUTINES 💜

🌟 new

Creates a new query. that's it. new query, new me, new era. ✨

---

🍓 ATTRIBUTES 🍓

💖 class

The class of the object you want to find. 👀

my $query = Search::GIN::Query::Class->new(
    class => 'Person',
);

🐒 does

A role consumed by the object you want to find. (yes, consumed, like it ate that role and now it's part of its whole personality.) 💅

my $query = Search::GIN::Query::Class->new(
    does => 'TheMonkey',
);

👑 blessed

The name of the package that the object is blessed into. very bless core of it, very perl of it. 🙈

my $query = Search::GIN::Query::Class->new(
    blessed => 'Person',
);

---

🌈 AUTHOR 🌈

XXXX XXX'XX (Yuval Kogman) <nothingmuch@woobling.org> — credit where credit is due, periodt. 🫶

---

⭐ COPYRIGHT AND LICENSE ⭐

This software is copyright (c) 2008 by XXXX XXX'XX (Yuval Kogman), Infinity Interactive. (that's Infinity Interactive, not just regular Interactive — infinity, bestie. slay.)

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. so like, go forth and share. 🌸

---

🧚 and that's the whole page! every flag, every attribute, every author, every license line — all present and accounted for, no skips, no shortcuts. 💯

perl v5.34.0 · 2022-06-17 — that's the version and date this page was generated, so shoutout to that build, and byeeee bestie, go write some queries 💖✨