Valida...isting(3pm)

💖 Validation::Class::Listing 💖

okay bestie, gather round, because this one is a whole mood — it's a page from the User Contributed Perl Documentation (the 3pm section, for my fellow perl girlies who live in man pages 🫶), and it's all about a lil container class that holds an arrayref. iconic behavior honestly.

✨ NAME ✨

Validation::Class::Listing — Generic Container Class for an Array Reference

like... it's a bucket. for stuff. an arrayref bucket. no cap. 🎀

---

🌸 VERSION 🌸

version 7.900059

(that's the version, keep it in your notes bestie, we don't skip the numbers here 💅)

---

🦋 SYNOPSIS 🦋

here's the vibe, straight up:

use Validation::Class::Listing;

my $foos = Validation::Class::Listing->new;

$foos->add('foo');
$foos->add('bar', 'baz');

print $foos->count; # 3 objects

so you make one, you shove 'foo' in there, then 'bar' and 'baz' together, and boom — count says 3 objects. it's giving organized. it's giving collected. 🌈

---

💜 DESCRIPTION 💜

Validation::Class::Listing is a container class that provides general-purpose functionality for arrayref objects.

that's the whole thesis bestie. it's a container. it holds arrayref objects. it does general-purpose stuff with them. lowkey the most reliable friend in the group chat. ✨

---

👑 METHODS 👑

every single one, no skips, no shortcuts, periodt:

💖 new 💖

my $self = Validation::Class::Listing->new;

💖 add 💖

$self = $self->add('foo', 'bar');

💖 clear 💖

$self = $self->clear;

💖 count 💖

my $count = $self->count;

💖 delete 💖

$value = $self->delete($index);

💖 defined 💖

$true if $self->defined($name) # defined

💖 each 💖

$self = $self->each(sub{

    my ($index, $value) = @_;

});

💖 first 💖

my $value = $self->first;

💖 get 💖

my $value = $self->get($index); # i.e. $self->[$index]

💖 grep 💖

$new_list = $self->grep(qr/update_/);

💖 has 💖

$true if $self->has($name) # defined

💖 iterator 💖

my $next = $self->iterator();

# defaults to iterating by keys but accepts sort, rsort, nsort, or rnsort
# e.g. $self->iterator('sort', sub{ (shift) cmp (shift) });

while (my $item = $next->()) {
    # do something with $item
}

ngl the iterator one is the main character of this whole list. it defaults to iterating by keys, but it also accepts sort, rsort, nsort, or rnsort, and you can hand it a custom sub like that one up there. 💅

💖 join 💖

my $string = $self->join($delimiter);

💖 last 💖

my $value = $self->last;

💖 list 💖

my @list = $self->list;

💖 nsort 💖

my @list = $self->nsort;

💖 pairs 💖

my @pairs = $self->pairs;
# or filter using $self->pairs('grep', $regexp);

foreach my $pair (@pairs) {
    # $pair->{index} is $pair->{value};
}

so each pair is a little hashref situation where $pair->{index} is $pair->{value} — cute right?? and you can filter the whole thing with $self->pairs('grep', $regexp). obsessed. 🍓

💖 rnsort 💖

my @list = $self->rnsort;

💖 rsort 💖

my @list = $self->rsort;

💖 sort 💖

my @list = $self->sort(sub{...});

💖 unique 💖

my @list = $self->unique();

---

🧚 AUTHOR 🧚

Al Newkirk <anewkirk@ana.io>

shoutout to Al, the legend who made all of this happen 🙈✨

---

🎀 COPYRIGHT AND LICENSE 🎀

This software is copyright (c) 2011 by Al Newkirk.

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 yeah bestie, it's free software — redistribute it, modify it, do your thing, just keep it under the same terms as the Perl 5 programming language system itself. that's the deal, and we respect the deal. 💜

---

and that's a wrap, fr fr! this page came to you from perl v5.36.0, dated 2023-06-11, live from the Valida...isting(3pm) corner of the manual. go forth and container-ize, bestie — you ate. 💅🔥👑