Difference between revisions of "Freeside:3:Documentation:Developer/FS/AccessRight"

From Freeside
Jump to: navigation, search
m (Edit via perl MediaWiki framework (1.13))
m (Edit via perl MediaWiki framework (1.13))
 
Line 1: Line 1:
 +
==NAME==
 +
FS::AccessRight - Access control rights.
  
 +
==SYNOPSIS==
 +
<code>
 +
  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} };
 +
  }
 +
</code>
 +
==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==
 +
[[Freeside:3:Documentation:Developer/FS/access right|FS::access_right]], [[Freeside:3:Documentation:Developer/FS/access group|FS::access_group]], [[Freeside:3:Documentation:Developer/FS/access user|FS::access_user]]

Latest revision as of 05:28, 10 February 2015

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