oqapi/webgui
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add documentation for magic numbers

Browse source
This commit is contained in:
Doug Bell 2011-04-19 11:13:20 -05:00
parent 06549c925d
commit 71aa7115de
2 changed files with 45 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

29
lib/WebGUI/Group.pm
View file

@ -71,6 +71,35 @@ This package provides an object-oriented way of managing WebGUI groups and group
$boolean = $group->userIsAdmin($userId,$groupId); $boolean = $group->userIsAdmin($userId,$groupId);
$epoch = $group->userGroupExpireDate($userId,$date); $epoch = $group->userGroupExpireDate($userId,$date);
=head1 MAGIC NUMBERS
These magic group IDs are used throughout WebGUI:
=over 4
=item 1
The visitors group. Only visitors are in this group, not registered users.
=item 2
The registered users group. Any user that is not a visitor is in this group.
=item 3
The admins group. This is the highest level of authority that can be given in
the site.
=item 7
Everyone. All Visitors and Registered Users are in this group.
=item 12
Turn Admin On group. This group is allowed to use the Admin interface.
=back
=head1 METHODS =head1 METHODS
These methods are available from this class: These methods are available from this class:

16
lib/WebGUI/User.pm
View file

@ -70,6 +70,22 @@ as getting/setting a users's profile data.
WebGUI::User->validUserId($session, $userId); WebGUI::User->validUserId($session, $userId);
=head1 MAGIC NUMBERS
These magic user IDs are used throughout WebGUI
=over 4
=item 1
Visitor. Any user that is not logged-in is a Visitor.
=item 3
Admin. This is the main site admin account.
=back
=head1 METHODS =head1 METHODS
These methods are available from this class: These methods are available from this class: