auth_admin
class auth_admin extends auth
ACP Permission/Auth class
Properties
$acl | from auth | ||
$cache | from auth | ||
$acl_options | from auth | ||
$acl_forum_ids | from auth |
Methods
Retrieves data wanted by acl function from the database for the specified user.
Look up an option if the option is prefixed with !, then the result becomes negated
Get forums with the specified permission setting
Get permission listing based on user_id/options/forum_ids
Get assigned roles
Get raw acl data based on user/option/forum
Get raw user based permission settings
Get raw group based permission settings
Get raw acl data based on user for caching user_permissions This function returns the same data as acl_raw_data(), but without the user id as the first key within the array.
Private function snippet for setting a specific piece of the hold_ary
Authentication plug-ins is largely down to Sergey Kanareykin, our thanks to him.
Fill auth_option statement for later querying based on the supplied options
Init auth settings
Get permission mask This function only supports getting permissions of one type (for example a_)
Get permission mask for roles This function only supports getting masks for one role
Display permission mask (assign to template)
Display permission mask for roles
NOTE: this function is not in use atm Add a new option to the list ... $options is a hash of form -> $options = array( 'local' => array('option1', 'option2', ...), 'global' => array('optionA', 'optionB', ...) );
Set a user or group ACL record
Set a role-specific ACL record
Remove local permission
Assign category to template used by display_mask()
Building content array from permission rows with explicit key ordering used by display_mask()
Use permissions from another user. This transferes a permission set from one user to another.
Details
in
auth at line 29
acl($userdata)
Init permissions
in
auth at line 109
array
obtain_user_data(int $user_id)
Retrieves data wanted by acl function from the database for the specified user.
in
auth at line 169
acl_get($opt, $f = 0)
Look up an option if the option is prefixed with !, then the result becomes negated
If a forum id is specified the local option will be combined with a global option if one exist. If a forum id is not specified, only the global option will be checked.
in
auth at line 218
array
acl_getf(string $opt, bool $clean = false)
Get forums with the specified permission setting
in
auth at line 299
acl_getf_global($opt)
Get local permission state for any forum.
Returns true if user has the permission in one or more forums, false if in no forum. If global option is checked it returns the global state (same as acl_get($opt)) Local option has precedence...
in
auth at line 343
acl_gets()
Get permission settings (more than one)
in
auth at line 380
acl_get_list($user_id = false, $opts = false, $forum_id = false)
Get permission listing based on user_id/options/forum_ids
Be careful when using this function with permissions a, m, u and f ! It may not work correctly. When a user group grants an a_* permission, e.g. a_foo, but the user's afoo permission is set to "Never", then the user does not in fact have the a permission. But the user will still be listed as having the a_ permission.
For more information see: http://tracker.phpbb.com/browse/PHPBB3-10252
in
auth at line 412
acl_cache($userdata)
Cache data to user_permissions row
in
auth at line 454
build_bitstring($hold_ary)
Build bitstring from permission set
in
auth at line 515
acl_clear_prefetch($user_id = false)
Clear one or all users cached permission settings
in
auth at line 572
acl_role_data($user_type, $role_type, $ug_id = false, $forum_id = false)
Get assigned roles
in
auth at line 605
acl_raw_data($user_id = false, $opts = false, $forum_id = false)
Get raw acl data based on user/option/forum
in
auth at line 721
acl_user_raw_data($user_id = false, $opts = false, $forum_id = false)
Get raw user based permission settings
in
auth at line 773
acl_group_raw_data($group_id = false, $opts = false, $forum_id = false)
Get raw group based permission settings
in
auth at line 829
acl_raw_data_single_user($user_id)
Get raw acl data based on user for caching user_permissions This function returns the same data as acl_raw_data(), but without the user id as the first key within the array.
in
auth at line 912
_set_group_hold_ary($hold_ary, $option_id, $setting)
Private function snippet for setting a specific piece of the hold_ary
in
auth at line 941
login($username, $password, $autologin = false, $viewonline = 1, $admin = 0)
Authentication plug-ins is largely down to Sergey Kanareykin, our thanks to him.
in
auth at line 1074
build_auth_option_statement($key, $auth_options, $sql_opts)
Fill auth_option statement for later querying based on the supplied options
at line 30
__construct()
Init auth settings
at line 76
get_mask(set|view $mode, mixed $user_id = false, mixed $group_id = false, mixed $forum_id = false, string $auth_option = false, local|global $scope = false, ACL_NEVER|ACL_NO|ACL_YES $acl_fill = ACL_NEVER)
Get permission mask This function only supports getting permissions of one type (for example a_)
at line 229
get_role_mask($role_id)
Get permission mask for roles This function only supports getting masks for one role
at line 267
display_mask($mode, $permission_type, $hold_ary, $user_mode = 'user', $local = false, $group_display = true)
Display permission mask (assign to template)
at line 631
display_role_mask($hold_ary)
Display permission mask for roles
at line 716
acl_add_option($options)
NOTE: this function is not in use atm Add a new option to the list ... $options is a hash of form -> $options = array( 'local' => array('option1', 'option2', ...), 'global' => array('optionA', 'optionB', ...) );
at line 826
acl_set($ug_type, $forum_id, $ug_id, $auth, $role_id = 0, $clear_prefetch = true)
Set a user or group ACL record
at line 959
acl_set_role($role_id, $auth)
Set a role-specific ACL record
at line 1022
acl_delete($mode, $ug_id = false, $forum_id = false, $permission_type = false)
Remove local permission
at line 1130
assign_cat_array($category_array, $tpl_cat, $tpl_mask, $ug_id, $forum_id, $s_view, $show_trace = false)
Assign category to template used by display_mask()
at line 1205
build_permission_array($permission_row, $content_array, $categories, $key_sort_array)
Building content array from permission rows with explicit key ordering used by display_mask()
at line 1269
ghost_permissions($from_user_id, $to_user_id)
Use permissions from another user. This transferes a permission set from one user to another.
The other user is always able to revert back to his permission set. This function does not check for lower/higher permissions, it is possible for the user to gain "more" permissions by this. Admin permissions will not be copied.