User::I...:Archive(3)

📦
version 4.00 · 9 versions
, in fedora 44

🦋 User::I...:Archive(3) — the manual page, but make it cute

okay so bestie, welcome to the group chat for User::Identity::Archive(3) — a User Contributed Perl Documentation page. Pull up a chair, grab a boba, we're doing lore 💖

✨ NAME ✨

User::Identity::Archive — it's the base class for archiving user information. That's it, that's the whole job description, she's a foundation, she's the blueprint, she's mother 👑

🌸 INHERITANCE 🌸

The family tree, bestie, get out your little ancestry dot com account:

User::Identity::Archive
  is a User::Identity::Item

User::Identity::Archive is extended by
  User::Identity::Archive::Plain

So she is a User::Identity::Item, and she gets extended by User::Identity::Archive::Plain. Passing the genes down, slay 🧬✨

🎀 SYNOPSIS 🎀

Here's the vibe check in code form, verbatim, don't touch a single character:

use User::Identity::Archive::Plain;
my $friends = User::Identity::Archive::Plain->new('friends');
$friends->from(\*FH);
$friends->from('.friends');

See? You make a friends archive, then you feed it a filehandle, then you feed it a file. Incredible. No notes. 💅

💜 DESCRIPTION 💜

So like — an archive stores collections. How and where that happens? Depends on the type of archive, bestie. Every archiver does its own thing. Also some archivers may limit the kinds of selections which can be stored — so don't come for them when they can't hold everything, they're doing their best 🫶

And it Extends "DESCRIPTION" in User::Identity::Item. So go read that one too, iykyk.

🔥 OVERLOADED 🔥

ngl this section is empty on the page — no overloaded operators listed, no cap. 🙈

⭐ METHODS ⭐

She Extends "METHODS" in User::Identity::Item — so a lot of what's below is inherited, and we're gonna say that every single time because the original does. Periodt.

🧚 Constructors

Extends "Constructors" in User::Identity::Item.

$class->new( [$name], %options )

The sacred option table, presented verbatim because I respect the lore:

-Option     --Defined in          --Default
 description  User::Identity::Item  undef
 from                               undef
 name         User::Identity::Item  <required>
 parent       User::Identity::Item  undef

And now the receipts, one by one:

  • description => STRING — default undef, defined in User::Identity::Item
  • from => $filehandle|$file — default undef 🍓
  • name => STRING — default <required>, defined in User::Identity::Item. Yeah bestie, she's required, you gotta name her 💅
  • parent => OBJECT — default undef, defined in User::Identity::Item

🎀 Attributes

Extends "Attributes" in User::Identity::Item.

  • $obj->description() — Inherited, see "Attributes" in User::Identity::Item
  • $obj->name( [$newname] ) — Inherited, see "Attributes" in User::Identity::Item

🌈 Collections

Extends "Collections" in User::Identity::Item.

  • $obj->add($collection, $role) — Inherited, see "Collections" in User::Identity::Item
  • $obj->addCollection( $object | <[$type], %options> ) — Inherited, see "Collections" in User::Identity::Item
  • $obj->collection($name) — Inherited, see "Collections" in User::Identity::Item
  • $obj->parent( [$parent] ) — Inherited, see "Collections" in User::Identity::Item
  • $obj->removeCollection($object|$name) — Inherited, see "Collections" in User::Identity::Item
  • $any->type() — Inherited, see "Collections" in User::Identity::Item
  • $obj->user() — Inherited, see "Collections" in User::Identity::Item

That's seven whole inherited baddies, we love a delegation moment 💖

🦋 Searching

Extends "Searching" in User::Identity::Item.

  • $obj->find($collection, $role) — Inherited, see "Searching" in User::Identity::Item

👑 Access to the archive

This is the main character section, obviously.

$obj->from($source, %options)

Read definitions from the specified $source, which usually can be a filehandle or filename. The syntax used in the information $source is archiver dependent — so like, don't assume, every archiver has its own handwriting ✍️

real talk bestie: Not all archivers implement from() — so you may want to check with UNIVERSAL::can() beforehand. Yes, that's exactly what the page says. Guard yourself, queen 🛡️

» example:

use User::Identity::Archive::Some;
my $a = User::Identity::Archive::Some->new('xyz');
$a->from(\*STDIN) if $a->can('from');

Look at that if $a->can('from') — that's the self-care. That's the boundary. That's the vibe check before you commit 🔥

💀 DIAGNOSTICS 💀

The moments where things go sideways. Dramatic, but accurate:

  • Error: cannot load collection module for $type ($class): $@ — Either the specified $type does not exist, or that module named $class returns compilation errors. If the type as specified in the warning is not the name of a package, you specified a nickname which was not defined. Maybe you forgot the 'require' the package which defines the nickname. Cast by addCollection()
  • Error: nvalid collection $name. — The collection with $name does not exist and can not be created. Cast by add()
and yes, that error really does say nvalid on the page — I am NOT fixing it, that's canon, character for character, no cap 💅
  • Error: this $object is not a collection. — Cast by addCollection()

🍓 SEE ALSO 🍓

This module is part of User-Identity version 4.00, built on December 12, 2025. Website: http://perl.overmeer.net/CPAN/ — go say hi, she's famous ✨

🌸 LICENSE 🌸

  • For contributors see file ChangeLog.
  • This software is copyright (c) 2003-2025 by Mark Overmeer. 🫶
  • This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
and that's the whole page, bestie — every option, every inherited method, every diagnostic, untouched. facts preserved, vibes upgraded. 💖

cute lil sign-off: this page came to you from perl v5.42.0 and is dated 2026-01-17. mwah, go forth and archive 💅🎀🦋

📦 where this page comes from