CPANPL...:Search(3pm)

πŸ“¦
version 0.9916 Β· 5 versions
, in debian trixie, ubuntu resolute, ubuntu stonking

okay bestie, welcome to CPANPL...:Search(3pm) β€” the User Contributed Perl Documentation page you didn't know you needed. This is the internals for searching for modules, and yeah, it's giving behind-the-scenes main character energy. πŸŽ€


✨ NAME ✨

CPANPLUS::Internals::Search β€” the internals for searching for modules. iykyk. πŸ¦‹


🌸 SYNOPSIS 🌸

    my $aref = $cpan->_search_module_tree(
                        type    => 'package',
                        allow   => [qr/DBI/],
                    );

    my $aref = $cpan->_search_author_tree(
                        type    => 'cpanid',
                        data    => \@old_results,
                        verbose => 1,
                        allow   => [qw|KANE AUTRIJUS|],
                    );

    my $aref = $cpan->_all_installed( );

look at that. so clean. so iconic. 🌈


πŸ’œ DESCRIPTION πŸ’œ

The functions in this module are literally designed to find module(objects) based on certain criteria and return them. that's it, that's the whole vibe. no cap. ✨


πŸ‘‘ METHODS πŸ‘‘

_search_module_tree( type => TYPE, allow => \@regexes, [data => \@previous_results ] )

Searches the moduletree for module objects matching the criteria you specify. Returns an array ref of module objects on success, and false on failure. periodt. πŸ’…

It takes the following arguments:

  • type β€” This can be any of the accessors for the CPANPLUS::Module objects. This is a required argument. 🫢
  • allow β€” A set of rules, or more precisely, a list of regexes (via qr// or plain strings), that the type must adhere too. You can specify as many as you like, and it will be treated as an "OR" search. For an "AND" search, see the data argument.

This is a required argument. no skipping it bestie 😀

  • data β€” An arrayref of previous search results. This is the way to do an "AND" search β€” _search_module_tree will only search the module objects specified in data if provided, rather than the moduletree itself. 🧚

_search_author_tree( type => TYPE, allow => \@regexex, [data => \@previous_results ] )

Searches the authortree for author objects matching the criteria you specify. Returns an array ref of author objects on success, and false on failure. same energy, different tree. 🌸

It takes the following arguments:

  • type β€” This can be any of the accessors for the CPANPLUS::Module::Author objects. This is a required argument. ⭐
  • allow β€” A set of rules, or more precisely, a list of regexes (via qr// or plain strings), that the type must adhere too. You can specify as many as you like, and it will be treated as an "OR" search. For an "AND" search, see the data argument.

This is a required argument. πŸ’–

  • data β€” An arrayref of previous search results. This is the way to do an "and" search β€” _search_author_tree will only search the author objects specified in data if provided, rather than the authortree itself. πŸ¦‹

_all_installed()

This function returns an array ref of module objects of modules that are installed on this system. that's it. short, sweet, slayed. πŸ‘‘


lowkey obsessed with how tidy these internals are. highkey a vibe check passed. βœ…

and that's the whole page, bestie! this little number is perl v5.40.1, dated 2025-03-01, and it's filed under CPANPL...:Search(3pm). go forth and search your lil heart out. πŸŽ€πŸ’–βœ¨

πŸ“¦ where this page comes from