RoPkg:...Mirrors(3pm)

πŸ“¦ version 0.8.4, in ubuntu jammy

πŸ’– RoPkg:...Mirrors β€” the manual page, but make it make sense πŸ’–

okay bestie, sit down, grab a boba, because we're reading the RoPkg:...Mirrors(3pm) page together and honestly? it's cute, it's short, it slays. this is a User Contributed Perl Documentation situation, so you know it's giving community-coded excellence. 🫢


✨ NAME ✨

RoPkg::Simba::Mirrors β€” that's the whole name, no notes, it ate. πŸ’…


🌸 VERSION 🌸

0.2.2 β€” yeah, that's the version, and yeah, we're obsessed with it. πŸŽ€


πŸ¦‹ DESCRIPTION πŸ¦‹

so basically, RoPkg::Simba::Mirrors is a class, right? and its whole job β€” its entire main character purpose β€” is to count the mirrors and get the mirrors from the database. that's it. that's the vibe. count 'em, fetch 'em. iconic behaviour, honestly. ✨


πŸ”₯ SYNOPSIS πŸ”₯

here's how you actually use it, copy-paste energy, no cap:

 !#/usr/bin/perl

 use RoPkg::DB;
 use RoPkg::Simba::Mirrors;

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

   my $m = new RoPkg::Simba::Mirrors(dbo => $dbp, dbo_method => 'db_local');

   print $m->Count,' mirrors found in database',$/;
 }

 main();

like, you spin up a RoPkg::DB, you Add your DSN and creds, you build a RoPkg::Simba::Mirrors with dbo and dbo_method, and then you just print the count. done. periodt. πŸ’œ


πŸ’« SUBROUTINES/METHODS πŸ’«

πŸŽ€ new()

the class constructor, bestie. and right now? at this very moment? it literally just calls RoPkg::DBObject->new() and minds its own business. so if you wanna know about the new() parameters, go read the RoPkg::DBObject manual page β€” it's all over there, and it's lowkey required reading. πŸ“–

🌈 Count($fields)

returns the number of mirrors from the database. the $fields parameter holds a list of WHERE clauses β€” you know, the "who, what, which ones" of it all. and for more details on $fields, go check SQL::Abstract. it's giving delegation and we respect it. ✨

🧚 Get($fields, $orderby)

returns an array of RoPkg::Simba::Mirror objects β€” actual objects, not vibes, okay? the mirrors get read straight from the database.

  • $fields = a list of WHERE clauses. again, more details over in SQL::Abstract. πŸ’…
  • $orderby = a reference to an array holding the fields specification used for sorting the data. so you control the order, you're the main character here. πŸ‘‘

πŸ’€ DIAGNOSTICS πŸ’€

want to run the diagnostics? unpack the source, and hit it with:

make test

that's the whole instruction. go off. πŸ”₯


🌸 CONFIGURATION AND ENVIRONMENT 🌸

this module does not use any configuration files. it does not use any environment variables. nothing. zero. it's self-sufficient, it doesn't need your dotfiles, it doesn't need your .env. a queen who needs nothing. πŸ™ˆ


πŸ“ DEPENDENCIES πŸ“

  • RoPkg::DBCollection
  • RoPkg::Excludes

those two. that's the whole squad. 🫢


⭐ INCOMPATIBILITIES ⭐

None known to the author. no drama, no feuds, no beef. we love a peaceful era. 🌈


😭 BUGS AND LIMITATIONS 😭

None known to the author. nothing to report, bestie. flawless behaviour, allegedly. ✨


πŸ‘‘ PERL CRITIC πŸ‘‘

this module is perl critic level 2 compliant. level 2!! it got graded and it passed and we're proud. πŸŽ€


πŸ’œ SEE ALSO πŸ’œ

  • RoPkg::Simba
  • RoPkg::Simba::Mirror
  • SQL::Abstract

read them, love them, they're family. πŸ¦‹


🌟 AUTHOR 🌟

Subredu Manuel <diablo@iasi.roedu.net> β€” the legend, the icon, 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 β€” so if you want the legal fine print, that's where it lives. no cap. 🫢


and that's the whole page, bestie. you understood it, you absorbed it, you're basically a RoPkg::Simba::Mirrors expert now. slay. πŸ’…βœ¨

this little rewrite was generated from the perl v5.28.1 documentation, dated 2018-12-09, for RoPkg:...Mirrors(3pm) β€” big love to whoever wrote the original, and big love to you for reading. bye bestie!! πŸŽ€πŸ’–πŸ¦‹

πŸ“¦ where this page comes from