phpBB3


phpBB3\auth
includes/auth.php at line 23

Class auth

auth
All Known Subclasses:
auth_admin

public class auth

Permission/Auth class


Field Summary
mixed

$acl

mixed

$acl_forum_ids

mixed

$acl_options

mixed

$cache

Method Summary
void

acl(mixed userdata)

Init permissions

void

acl_get(mixed opt, int f)

Look up an option if the option is prefixed with !, then the result becomes negatedIf a forum id is specified the local option will be combined with a global option if one exist.

void

acl_getf(bool clean, mixed opt)

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

void

acl_getf_global(mixed opt)

Get local permission state for any forum.

void

acl_gets()

Get permission settings (more than one)

void

acl_get_list(bool user_id, bool opts, bool forum_id)

Get permission listing based on user_id/options/forum_idsBe careful when using this function with permissions a_, m_, u_ and f_ ! It may not work correctly.

void

acl_cache(mixed userdata)

Cache data to user_permissions row

void

build_bitstring(mixed hold_ary)

Build bitstring from permission set

void

acl_clear_prefetch(bool user_id)

Clear one or all users cached permission settings

void

acl_role_data(mixed user_type, mixed role_type, bool ug_id, bool forum_id)

Get assigned roles

void

acl_raw_data(bool user_id, bool opts, bool forum_id)

Get raw acl data based on user/option/forum

void

acl_user_raw_data(bool user_id, bool opts, bool forum_id)

Get raw user based permission settings

void

acl_group_raw_data(bool group_id, bool opts, bool forum_id)

Get raw group based permission settings

void

acl_raw_data_single_user(mixed 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.

void

login(mixed username, mixed password, bool autologin, int viewonline, int admin)

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

void

build_auth_option_statement(mixed key, mixed auth_options, mixed sql_opts)

Fill auth_option statement for later querying based on the supplied options

Field Detail

includes/auth.php at line 25

acl

public mixed $acl = array()

includes/auth.php at line 28

acl_forum_ids

public mixed $acl_forum_ids = false

includes/auth.php at line 27

acl_options

public mixed $acl_options = array()

includes/auth.php at line 26

cache

public mixed $cache = array()

Method Detail

includes/auth.php at line 33

acl

public void acl(mixed userdata)

Init permissions


includes/auth.php at line 153

acl_get

public void acl_get(mixed opt, int 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.


includes/auth.php at line 199

acl_getf

public void acl_getf(bool clean, mixed opt)

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

Parameters:
clean - set to true if only values needs to be returned which are set/unset

includes/auth.php at line 280

acl_getf_global

public void acl_getf_global(mixed 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...


includes/auth.php at line 324

acl_gets

public void acl_gets()

Get permission settings (more than one)


includes/auth.php at line 361

acl_get_list

public void acl_get_list(bool user_id, bool opts, bool forum_id)

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 a_foo 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


includes/auth.php at line 393

acl_cache

public void acl_cache(mixed userdata)

Cache data to user_permissions row


includes/auth.php at line 435

build_bitstring

public void build_bitstring(mixed hold_ary)

Build bitstring from permission set


includes/auth.php at line 496

acl_clear_prefetch

public void acl_clear_prefetch(bool user_id)

Clear one or all users cached permission settings


includes/auth.php at line 540

acl_role_data

public void acl_role_data(mixed user_type, mixed role_type, bool ug_id, bool forum_id)

Get assigned roles


includes/auth.php at line 570

acl_raw_data

public void acl_raw_data(bool user_id, bool opts, bool forum_id)

Get raw acl data based on user/option/forum


includes/auth.php at line 678

acl_user_raw_data

public void acl_user_raw_data(bool user_id, bool opts, bool forum_id)

Get raw user based permission settings


includes/auth.php at line 724

acl_group_raw_data

public void acl_group_raw_data(bool group_id, bool opts, bool forum_id)

Get raw group based permission settings


includes/auth.php at line 771

acl_raw_data_single_user

public void acl_raw_data_single_user(mixed 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.


includes/auth.php at line 883

login

public void login(mixed username, mixed password, bool autologin, int viewonline, int admin)

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


includes/auth.php at line 984

build_auth_option_statement

public void build_auth_option_statement(mixed key, mixed auth_options, mixed sql_opts)

Fill auth_option statement for later querying based on the supplied options


phpBB3