Biblio...Segment(3pm)

💖 Biblio::SICI::ContributionSegment — the contribution segment of a SICI 💖

okay bestie, so this is a Perl module from the Biblio::SICI universe (perl documentation, user contributed, the whole vibe) and it's literally just the contribution segment of a SICI. that's it. that's the girl. ✨

🌸 VERSION 🌸

version 0.04 — vintage but iconic 💅

---

🦋 SYNOPSIS 🦋

my $sici = Biblio::SICI->new();

$sici->contribution->location('6-21');

like… look at her go. one constructor, one method call, done. we love a low-effort queen 👑

---

🎀 DESCRIPTION 🎀

not me showing up to say this first but: you are expected to NOT directly instantiate objects of this class!! 🚫🙈

fr fr. do not new this yourself. she's not for you like that, she's got a whole thing going on with the parent object. let her be.

so what even is a contribution segment? it's the part of a SICI that holds info about a contribution to an item — think: an article published in a journal issue. that's the energy. 📖✨

and here's the cute part: a SICI can be perfectly valid without any contribution data at all, so this segment can just be empty / unused. she's optional and unbothered. she's not desperate. 🧚

for further information please have a look at the standard. (iykyk, go read the standard, bestie 📚)

---

💜 ATTRIBUTES 💜

for each attribute, clearer (clear_) and predicate (has_) methods are provided. so for every one of these girls you get a "wipe her" and a "does she exist" check. iconic utility, no cap 🫶

• location — where the contribution sits inside the item. a typical example would be the range of pages an article was printed on. so like, page range vibes. 📄
• titleCode — a special code of no more than 6 characters, derived from the title of the contribution. the rules for how to construct the code are provided in the standard. so don't freestyle it, bestie, the standard has the recipe. 🔤
• localNumber — an opaque number that somehow describes the contribution in the context of its item. "opaque" meaning don't look at her too hard, she's mysterious on purpose. 🔢

---

🔥 METHODS 🔥

⭐ STRING to_string()

returns a stringified representation of the data in the contribution segment. she said "let me put it in a string for you" and she did. 💅

⭐ reset()

resets all attributes to their default values.

⚠️ hold up — plot twist ⚠️ resetting the contribution segment also resets the value of the csi attribute in the control segment! so this is not a local girlboss move, she reaches over and touches the control segment too. know that before you hit reset. 😭💀

⭐ BOOL is_valid()

checks if the data for the contribution segment conforms to the standard. returns a boolean, so true/false, valid/not valid, slay/not slay. 🔥

---

🌈 SEE ALSO 🌈

• Biblio::SICI::Role::ValidSegment

go read that one too, bestie, they're linked for a reason 🫶

---

👑 AUTHOR 👑

Heiko Jansen <hjansen@cpan.org> — thank you for your service, king 🫡💖

---

🌸 COPYRIGHT AND LICENSE 🌸

this software is copyright (c) 2014 by Heiko Jansen.

this is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. periodt. ✨

---

and that's the whole page, bestie! 🎀 this one came from perl v5.36.0, dated 2023-02-06, and the header up top was Biblio...Segment(3pm) — which is just the long name getting squished, we've all been there. mwah, go read the standard 💋💜