Neil Bowers > PAUSE-Permissions-0.10 > PAUSE::Permissions::Module

Download:
PAUSE-Permissions-0.10.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

New  1
Open  1
View/Report Bugs
Module Version: 0.10   Source  

NAME ^

PAUSE::Permissions::Module - PAUSE permissions for one module (from 06perms.txt)

SYNOPSIS ^

 use PAUSE::Permissions::Module;

 my %options =
    (
     name => 'HTTP::Client',
     m    => 'LINC',
     f    => 'P5P,
     c    => ['NEILB'],
    );
  
 my $mp = PAUSE::Permissions::Module->new( %options );
 
 print "owner = ", $mp->owner, "\n";

DESCRIPTION ^

PAUSE::Permissions::Module is a data class, an instance of which is returned by the module_permissions() method in PAUSE::Permissions. It's not expected that you'll instantiate this module yourself, but you're probably reading this to find out what methods are supported.

METHODS ^

To understand the three levels of PAUSE permissions, see "The 06params.txt file" in PAUSE::Permissions.

owner

Returns a single PAUSE id, or undef.

co_maintainers

Returns a list of PAUSE ids, which will be empty if the module doesn't have any co-maintainers. The list will be sorted alphabetically.

Note: if a module has both an 'm' permission and an 'f' permission, then the user with the 'f' permission will included in the list returned by co_maintainers(), because PAUSE treats them as a co-maintainer.

registered_maintainer

Returns the PAUSE id of the registered maintainer of the module (the 'm' permission), or undef if there isn't one defined for the module.

first_come

Returns the PAUSE id of the 'first uploader' for the module (the 'f' permission), or undef if there isn't one defined for the module.

all_maintainers

Returns the PAUSE id of all users who have permissions for this module, in alphabetical order.

SEE ALSO ^

PAUSE::Permissions

AUTHOR ^

Neil Bowers <neilb@cpan.org>

Thanks to Andreas König, for patiently answering many questions on how this stuff all works.

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2012-2013 by Neil Bowers <neilb@cpan.org>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: