CPANPLUS::Module::Author(3) User Contributed Perl Documentation CPANPLUS::Module::Author(3)NAME
CPANPLUS::Module::Author - CPAN author object for CPANPLUS
SYNOPSIS
my $author = CPANPLUS::Module::Author->new(
author => 'Jack Ashton',
cpanid => 'JACKASH',
_id => INTERNALS_OBJECT_ID,
);
$author->cpanid;
$author->author;
$author->email;
@dists = $author->distributions;
@mods = $author->modules;
@accessors = CPANPLUS::Module::Author->accessors;
DESCRIPTION
"CPANPLUS::Module::Author" creates objects from the information in the source files. These can then be used to query on.
These objects should only be created internally. For "fake" objects, there's the "CPANPLUS::Module::Author::Fake" class.
ACCESSORS
An objects of this class has the following accessors:
author
Name of the author.
cpanid
The CPAN id of the author.
email
The email address of the author, which defaults to '' if not provided.
parent
The "CPANPLUS::Internals::Object" that spawned this module object.
METHODS
$auth = CPANPLUS::Module::Author->new( author => AUTHOR_NAME, cpanid => CPAN_ID, _id => INTERNALS_ID [, email => AUTHOR_EMAIL] )
This method returns a "CPANPLUS::Module::Author" object, based on the given parameters.
Returns false on failure.
@mod_objs = $auth->modules()
Return a list of module objects this author has released.
@dists = $auth->distributions()
Returns a list of module objects representing all the distributions this author has released.
CLASS METHODS
accessors ()
Returns a list of all accessor methods to the object
perl v5.16.3 2013-05-20 CPANPLUS::Module::Author(3)
Check Out this Related Man Page
CPANPLUS::Internals::Search(3pm) Perl Programmers Reference Guide CPANPLUS::Internals::Search(3pm)NAME
CPANPLUS::Internals::Search - internals for searching for modules
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( );
DESCRIPTION
The functions in this module are designed to find module(objects) based on certain criteria and return them.
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.
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.
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.
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.
perl v5.16.2 2012-10-11 CPANPLUS::Internals::Search(3pm)