DBIx::...Method(3pm)

💖 DBIx::Class::Helper::Row::ProxyResultSetMethod 💖

okay so real talk, bestie — this page lives in User Contributed Perl Documentation, and the module's whole government name is DBIx::Class::Helper::Row::ProxyResultSetMethod. yes it's long. no we are not shortening it. it's iconic that way. 🎀

---

✨ NAME ✨

DBIx::Class::Helper::Row::ProxyResultSetMethod — reuse your ResultSet methods from your results, efficiently, and with a lil fallback safety net for when you forgot to set things up. 🦋

---

🌸 SYNOPSIS 🌸

so here's the ResultSet situation, bestie:

package MyApp::Schema::ResultSet::Foo;

use parent 'DBIx::Class::ResultSet';

__PACKAGE__->load_components(qw(
   Helper::ResultSet::CorrelateRelationship
));

...;

sub with_friend_count {
   shift->search(undef, {
      '+columns' => {
         'friend_count' => $self->correlate('friends')->count_rs->as_query,
      },
   })
}

and here's the Result side, being all cute and delegating:

package MyApp::Schema::Result::Foo;

use parent 'DBIx::Class::Core';

__PACKAGE__->load_components(qw( Helper::Row::ProxyResultSetMethod ));

__PACKAGE__->proxy_resultset_method('friend_count');

or if you're a DBIx::Class::Candy girlie (and honestly? valid):

package MyApp::Schema::Result::Foo;

use DBIx::Class::Candy -components => ['Helper::Row::ProxyResultSetMethod'];

proxy_resultset_method 'friend_count';

and Elsewhere, where the magic actually happens:

my $row = $foo_rs->first;
say $row->friend_count . ' friends';

it just works. periodt. 💅

---

🌈 DESCRIPTION 🌈

okay so the whole point: this module makes reusing resultset methods from a result trivially easy. like, laughably easy. and honestly?

You should be using it.

that's not me being dramatic, that's the module being dramatic. it said it. I'm just the messenger. 💀

---

👑 METHODS 👑

🎀 proxy_resultset_method 🎀

the signature, verbatim, don't come for me:

__PACKAGE__->proxy_resultset_method( $name => {
   slot             => $slot,
   resultset_method => $rs_method
});

okay so let's break it down, bestie:

• the first argument is $name — that's the name of the method we're generating. it is required. no name, no method, no vibes. 🙈
• the other two, $slot and $resultset_method, are optional. yes queen, optional.
• if you don't say anything, $slot defaults to $name, and $resultset_method defaults to "with_$name". cute, right?
• $slot is the column that the data being retrieved is stored as, inside the ResultSet method you're proxying to.
• $resultset_method is (duh) the ResultSet method being proxied to.

and here's the part that's giving main character energy: if you did not call the "with_*" method on your ResultSet, and then you call the proxy method, it will transparently fallback and do the call itself and fetch the needed data. E.g.:

my $foo = $schema->resultset('Foo')->first; ## did not call with_friend_count
print $foo->friend_count; ## will produce desired result magically

magically. the manpage said magically. I'm just quoting. ✨

---

🍓 CANDY EXPORTS 🍓

if you use this component alongside DBIx::Class::Candy, it will export:

• proxy_resultset_method

that's it. that's the whole export list. short and sweet, we love her. 💜

---

🧚 DEDICATION 🧚

this module is dedicated to Ray Bradbury, who wrote Something Wicked This Way Comes, Dandelion Wine, and numerous short stories, plays, etc etc. Read this author's books.

like, actually read them. that's a direct instruction from the module. 📚✨

---

⭐ AUTHOR ⭐

Arthur Axel "fREW" Schmidt <frioux+cpan@gmail.com>

---

💜 COPYRIGHT AND LICENSE 💜

This software is copyright (c) 2024 by Arthur Axel "fREW" Schmidt.

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 🫶 — brought to you by perl v5.40.0, dated 2024-11-16, and yes the footer does say DBIx::...Method(3pm) because even the manpage header got tired of typing the whole name. slay. 💅🌸