phpBB API Documentation
Class

auth

class auth

Permission/Auth class

Properties

$acl
$cache
$acl_options
$acl_forum_ids

Methods

acl($userdata)

Init permissions

_fill_acl($user_permissions)

Fill ACL array with relevant bitstrings from user_permissions column

acl_get($opt, $f)

Look up an option if the option is prefixed with !, then the result becomes negated

acl_getf($opt, $clean = false)

Get forums with the specified permission setting if the option is prefixed with !, then the result becomes nagated

acl_getf_global($opt)

Get local permission state for any forum.

acl_gets()

Get permission settings (more than one)

acl_get_list($user_id = false, $opts = false, $forum_id = false)

Get permission listing based on userid/options/forumids

acl_cache($userdata)

Cache data to user_permissions row

build_bitstring($hold_ary)

Build bitstring from permission set

acl_clear_prefetch($user_id = false)

Clear one or all users cached permission settings

acl_role_data($user_type, $role_type, $ug_id = false, $forum_id = false)

Get assigned roles

acl_raw_data($user_id = false, $opts = false, $forum_id = false)

Get raw acl data based on user/option/forum

acl_user_raw_data($user_id = false, $opts = false, $forum_id = false)

Get raw user based permission settings

acl_group_raw_data($group_id = false, $opts = false, $forum_id = false)

Get raw group based permission settings

acl_raw_data_single_user($user_id)

Get raw acl data based on user for caching userpermissions This function returns the same data as aclraw_data(), but without the user id as the first key within the array.

_set_group_hold_ary($hold_ary, $option_id, $setting)

Private function snippet for setting a specific piece of the hold_ary

login($username, $password, $autologin = false, $viewonline = 1, $admin)

Authentication plug-ins is largely down to Sergey Kanareykin, our thanks to him.

build_auth_option_statement($key, $auth_options, $sql_opts)

Fill auth_option statement for later querying based on the supplied options

Details

at line 33
public acl($userdata)

Init permissions

Parameters

$userdata

at line 110
public _fill_acl($user_permissions)

Fill ACL array with relevant bitstrings from user_permissions column

Parameters

$user_permissions

at line 153
public acl_get($opt, $f)

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.

Parameters

$opt
$f

at line 199
public acl_getf($opt, $clean = false)

Get forums with the specified permission setting if the option is prefixed with !, then the result becomes nagated

Parameters

$opt
$clean

at line 280
public 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...

Parameters

$opt

at line 324
public acl_gets()

Get permission settings (more than one)

at line 361
public acl_get_list($user_id = false, $opts = false, $forum_id = false)

Get permission listing based on userid/options/forumids

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. afoo, 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

Parameters

$user_id
$opts
$forum_id

at line 393
public acl_cache($userdata)

Cache data to user_permissions row

Parameters

$userdata

at line 435
public build_bitstring($hold_ary)

Build bitstring from permission set

Parameters

$hold_ary

at line 496
public acl_clear_prefetch($user_id = false)

Clear one or all users cached permission settings

Parameters

$user_id

at line 543
public acl_role_data($user_type, $role_type, $ug_id = false, $forum_id = false)

Get assigned roles

Parameters

$user_type
$role_type
$ug_id
$forum_id

at line 576
public acl_raw_data($user_id = false, $opts = false, $forum_id = false)

Get raw acl data based on user/option/forum

Parameters

$user_id
$opts
$forum_id

at line 692
public acl_user_raw_data($user_id = false, $opts = false, $forum_id = false)

Get raw user based permission settings

Parameters

$user_id
$opts
$forum_id

at line 744
public acl_group_raw_data($group_id = false, $opts = false, $forum_id = false)

Get raw group based permission settings

Parameters

$group_id
$opts
$forum_id

at line 797
public acl_raw_data_single_user($user_id)

Get raw acl data based on user for caching userpermissions This function returns the same data as aclraw_data(), but without the user id as the first key within the array.

Parameters

$user_id

at line 880
public _set_group_hold_ary($hold_ary, $option_id, $setting)

Private function snippet for setting a specific piece of the hold_ary

Parameters

$hold_ary
$option_id
$setting

at line 909
public login($username, $password, $autologin = false, $viewonline = 1, $admin)

Authentication plug-ins is largely down to Sergey Kanareykin, our thanks to him.

Parameters

$username
$password
$autologin
$viewonline
$admin

at line 1011
public build_auth_option_statement($key, $auth_options, $sql_opts)

Fill auth_option statement for later querying based on the supplied options

Parameters

$key
$auth_options
$sql_opts