<% include( '/elements/header.html', 'Developer Documentation' ) %> <& /elements/menubar.html, 'Freeside Perl Modules' => $fsurl.'docs/library/FS.html', 'Complete Index' => $fsurl.'docs/library/index.html', &>

FS::AccessRight

NAME

FS::AccessRight - Access control rights.

SYNOPSIS

  use FS::AccessRight;

  my @rights = FS::AccessRight->rights;

  #my %rights = FS::AccessRight->rights_categorized;
  tie my %rights, 'Tie::IxHash', FS::AccessRight->rights_categorized;
  foreach my $category ( keys %rights ) {
    my @category_rights = @{ $rights{$category} };
  }

DESCRIPTION

Access control rights - Permission to perform specific actions that can be assigned to users and/or groups.

CLASS METHODS

rights

Returns the full list of right names.

default_superuser_rights

Most (but not all) right names.

rights_info

Returns a list of key-value pairs suitable for assigning to a hash. Keys are category names and values are list references of rights. Each element of the list reference scalar right name or a hashref with the following keys:

rightname - Right name
desc - Extended right description
global - Global flag, indicates that this access right provides access to global data which is shared among all agents.

BUGS

Damn those infernal six-legged creatures!

SEE ALSO

FS::access_right, FS::access_group, FS::access_user

<% include ('/elements/footer.html' ) %>