RoPkg:...Exclude(3pm)

📦 version 0.8.4, in ubuntu jammy

💖 NAME 💖

RoPkg::Simba::Exclude — yes bestie, this is the page for RoPkg:...Exclude(3pm), living its best life in the User Contributed Perl Documentation section, and we are going to read it together like the iconic little class it is. 💅

✨ VERSION ✨

0.1.2 — she's a lil vintage but she still slays, no cap. 🎀

🌸 DESCRIPTION 🌸

RoPkg::Simba::Exclude is the class that simba uses to mess with an exclude list. That's literally her whole job and she does it flawlessly. ✨

She comes with all the basic sql methods already loaded up — inherited straight from RoPkg::DBObject, so you don't gotta write them yourself. Main character inheritance energy, fr fr. 👑

🦋 SYNOPSIS 🦋

Okay so here's how you actually use her, copy-paste this and you're golden:

!#/usr/bin/perl

use RoPkg::DB;
use RoPkg::Simba::Exclude;

sub main {
  my $dbp = new RoPkg::DB();
  $dbp->Add('dbi:mysql:database=mysql;host=localhost',
            'root',
            '',
            'local');

  my $c = new RoPkg::Simba::Exclude(db => $dbp, db_method => 'db_local');
  $c->id(1);
  $c->Load();
}

main();

Look at that. Gorgeous. No notes. 🌈

🧚 SUBROUTINES/METHODS 🧚

Heads up bestie, this is important: all methods besides new will raise an OutsideClass exception if you try to call them outside of a class instance. Like, she does NOT do random strangers. 🙅‍♀️

Also, some methods may raise diferent exceptions depending on the vibe. So please, please, please read the section where the method you care about is described to find out more info about those exceptions. It's giving "read the room" but make it documentation. 💀

🎀 new()

The class constructor, the origin story, the birth of a star. 🌟 At this moment in time, she just calls RoPkg::DBObject->new(). That's it, that's the whole thing.

If you want the tea on what parameters new() takes, go read the RoPkg::DBObject manual page, bestie. 👑

🎀 table()

Returns the name of the exclude lists database table. Just the name. Simple queen behaviour. 💅

🎀 ExList()

Get/set the excluded items. 🍓

When you pick the set behaviour, you must pass the exclude list into the method. And lowkey important: the exclude list has to be set before you add the new exclude list to the database. Order matters, don't skip steps. ⭐

🎀 AddItems(@new_items)

Adds @new_items to the list of excluded items, and returns the new number of excluded items. So you always know how many lil guys are on the list now. 🧮✨

🎀 GetItems()

Returns the list of excluded items. 🎁

And in scalar context? She returns the number of excluded items instead. Context-sensitive icon. 👑

The following methods are get/set methods for all fields of a mirror.
  • id
  • MirrorID
  • CommandID

🎀 Add()

Adds the mirror to the database. 🗄️✨

This method is a wrapper for RoPkg::DBObject::SQL_Insert.

On success, 0 is returned. On error, a DBI exception is raised. No cap.

🎀 Delete()

Deletes the current exclude list from the database. 💀🗑️

Before you call this one, you should set the id of the exclude list. If you don't set the id, a Param::Missing exception gets raised. She said "where's the id, bestie?" 😭

On database operation success, 0 is returned. On database error, a DBI exception is raised.

🎀 Update()

Updates the current exclude list object with the database. 🔄💖

Before calling this method, you should set the id of the exclude list. If you don't set the id, a Param::Missing exception is raised. Same energy as Delete(), she is consistent. 💅

On database operation success, 0 is returned. On database error, a DBI exception is raised.

🎀 Load()

Loads the exclude list from the database, into the current object. 📥🦋

Before calling this method you should have set id, or MirrorID and CommandID. If none of those are found, then Param::Missing is raised. Give her something to work with, please. 🙈

On database operation success, 0 is returned. On database error, a DBI exception is raised.

🔥 DIAGNOSTICS 🔥

Unpack the source, and use the make test command. That's the whole diagnostic ritual, go off. ⭐

🌈 CONFIGURATION AND ENVIRONMENT 🌈

This module does not use any configuration files or environment variables. Zero. None. She's low maintenance like that. 🧚

💜 DEPENDENCIES 💜

  • RoPkg::DBObject
  • RoPkg::Exceptions

🚫 INCOMPATIBILITIES 🚫

None known to the author. Clean slate, no drama. ✨

🙈 BUGS AND LIMITATIONS 🙈

None known to the author. (Famous last words, but we're choosing to believe. 🫶)

👑 PERL CRITIC 👑

This module is perl critic level 2 compliant — with 1 exception. One single exception. We do not discuss it. 💅

🌟 SEE ALSO 🌟

  • RoPkg::Simba::Excludes
  • RoPkg::Exceptions
  • RoPkg::Object

💖 AUTHOR 💖

Subredu Manuel <diablo@iasi.roedu.net> — legend, icon, and the moment. 👑

Copyright (C) 2005 Subredu Manuel. All Rights Reserved. 📜

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The LICENSE file contains the full text of the license — go read it if you want the fine print, bestie. 💖

Okay that's the whole page, and if you made it all the way down here: slay. This was perl v5.28.1, dated 2018-12-09, and yes, RoPkg:...Exclude(3pm) is still that girl. Bye bestie, go exclude some packages responsibly. 🦋✨💅

📦 where this page comes from