'\" te .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "CPANPLUS::Internals::Search 3" .TH CPANPLUS::Internals::Search 3 "2012-11-03" "perl v5.12.5" "Perl Programmers Reference Guide" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" CPANPLUS::Internals::Search .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 4 \& my $aref = $cpan\->_search_module_tree( \& type => \*(Aqpackage\*(Aq, \& allow => [qr/DBI/], \& ); \& \& my $aref = $cpan\->_search_author_tree( \& type => \*(Aqcpanid\*(Aq, \& data => \e@old_results, \& verbose => 1, \& allow => [qw|KANE AUTRIJUS|], \& ); \& \& my $aref = $cpan\->_all_installed( ); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" The functions in this module are designed to find module(objects) based on certain criteria and return them. .SH "METHODS" .IX Header "METHODS" .SS "_search_module_tree( type => \s-1TYPE\s0, allow => \e@regexes, [data => \e@previous_results ] )" .IX Subsection "_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. .PP It takes the following arguments: .IP "type" 4 .IX Item "type" This can be any of the accessors for the \f(CW\*(C`CPANPLUS::Module\*(C'\fR objects. This is a required argument. .IP "allow" 4 .IX Item "allow" A set of rules, or more precisely, a list of regexes (via \f(CW\*(C`qr//\*(C'\fR or plain strings), that the \f(CW\*(C`type\*(C'\fR must adhere too. You can specify as many as you like, and it will be treated as an \f(CW\*(C`OR\*(C'\fR search. For an \f(CW\*(C`AND\*(C'\fR search, see the \f(CW\*(C`data\*(C'\fR argument. .Sp This is a required argument. .IP "data" 4 .IX Item "data" An arrayref of previous search results. This is the way to do an \f(CW\*(C`AND\*(C'\fR search \*(-- \f(CW\*(C`_search_module_tree\*(C'\fR will only search the module objects specified in \f(CW\*(C`data\*(C'\fR if provided, rather than the moduletree itself. .SS "_search_author_tree( type => \s-1TYPE\s0, allow => \e@regexex, [data => \e@previous_results ] )" .IX Subsection "_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. .PP It takes the following arguments: .IP "type" 4 .IX Item "type" This can be any of the accessors for the \f(CW\*(C`CPANPLUS::Module::Author\*(C'\fR objects. This is a required argument. .IP "allow" 4 .IX Item "allow" A set of rules, or more precisely, a list of regexes (via \f(CW\*(C`qr//\*(C'\fR or plain strings), that the \f(CW\*(C`type\*(C'\fR must adhere too. You can specify as many as you like, and it will be treated as an \f(CW\*(C`OR\*(C'\fR search. For an \f(CW\*(C`AND\*(C'\fR search, see the \f(CW\*(C`data\*(C'\fR argument. .Sp This is a required argument. .IP "data" 4 .IX Item "data" An arrayref of previous search results. This is the way to do an \f(CW\*(C`and\*(C'\fR search \*(-- \f(CW\*(C`_search_author_tree\*(C'\fR will only search the author objects specified in \f(CW\*(C`data\*(C'\fR if provided, rather than the authortree itself. .SS "\fI_all_installed()\fP" .IX Subsection "_all_installed()" This function returns an array ref of module objects of modules that are installed on this system. .\" Oracle has added the ARC stability level to this manual page .SH ATTRIBUTES See .BR attributes (5) for descriptions of the following attributes: .sp .TS box; cbp-1 | cbp-1 l | l . ATTRIBUTE TYPE ATTRIBUTE VALUE = Availability runtime/perl-512 = Stability Uncommitted .TE .PP .SH NOTES .\" Oracle has added source availability information to this manual page This software was built from source available at https://java.net/projects/solaris-userland. The original community source was downloaded from http://www.cpan.org/src/5.0/perl-5.12.5.tar.bz2 Further information about this software can be found on the open source community website at http://www.perl.org/.