auth
class auth
Permission/Auth class
Properties
| $acl | |||
| $cache | |||
| $acl_options | |||
| $acl_forum_ids |
Methods
Init permissions
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 local permission state for any forum.
Get permission settings (more than one)
Get permission listing based on user_id/options/forum_ids
Cache data to user_permissions row
Build bitstring from permission set
Clear one or all users cached permission settings
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
Details
at line 29
acl($userdata)
Init permissions
at line 109
array
obtain_user_data(int $user_id)
Retrieves data wanted by acl function from the database for the specified user.
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.
at line 218
array
acl_getf(string $opt, bool $clean = false)
Get forums with the specified permission setting
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...
at line 343
acl_gets()
Get permission settings (more than one)
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
at line 412
acl_cache($userdata)
Cache data to user_permissions row
at line 454
build_bitstring($hold_ary)
Build bitstring from permission set
at line 515
acl_clear_prefetch($user_id = false)
Clear one or all users cached permission settings
at line 572
acl_role_data($user_type, $role_type, $ug_id = false, $forum_id = false)
Get assigned roles
at line 605
acl_raw_data($user_id = false, $opts = false, $forum_id = false)
Get raw acl data based on user/option/forum
at line 721
acl_user_raw_data($user_id = false, $opts = false, $forum_id = false)
Get raw user based permission settings
at line 773
acl_group_raw_data($group_id = false, $opts = false, $forum_id = false)
Get raw group based permission settings
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.
at line 912
_set_group_hold_ary($hold_ary, $option_id, $setting)
Private function snippet for setting a specific piece of the hold_ary
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.
at line 1074
build_auth_option_statement($key, $auth_options, $sql_opts)
Fill auth_option statement for later querying based on the supplied options