[ Index ]

PHP Cross Reference of phpBB-3.3.0-deutsch

title

Body

[close]

/phpbb/auth/ -> auth.php (summary)

This file is part of the phpBB Forum Software package.

Copyright: (c) phpBB Limited
License: GNU General Public License, version 2 (GPL-2.0)
File Size: 1122 lines (32 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

auth:: (19 methods):
  acl()
  obtain_user_data()
  _fill_acl()
  acl_get()
  acl_getf()
  acl_getf_global()
  acl_gets()
  acl_get_list()
  acl_cache()
  build_bitstring()
  acl_clear_prefetch()
  acl_role_data()
  acl_raw_data()
  acl_user_raw_data()
  acl_group_raw_data()
  acl_raw_data_single_user()
  _set_group_hold_ary()
  login()
  build_auth_option_statement()


Class: auth  - X-Ref

Permission/Auth class

acl(&$userdata)   X-Ref
Init permissions


obtain_user_data($user_id)   X-Ref
Retrieves data wanted by acl function from the database for the
specified user.

return: array User attributes
param: int $user_id User ID

_fill_acl($user_permissions)   X-Ref
Fill ACL array with relevant bitstrings from user_permissions column


acl_get($opt, $f = 0)   X-Ref
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.

acl_getf($opt, $clean = false)   X-Ref
Get forums with the specified permission setting

return: array Contains the forum ids with the specified permission set to true.
param: string $opt The permission name to lookup. If prefixed with !, the result is negated.
param: bool    $clean set to true if only values needs to be returned which are set/unset

acl_getf_global($opt)   X-Ref
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...

acl_gets()   X-Ref
Get permission settings (more than one)


acl_get_list($user_id = false, $opts = false, $forum_id = false)   X-Ref
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

acl_cache(&$userdata)   X-Ref
Cache data to user_permissions row


build_bitstring(&$hold_ary)   X-Ref
Build bitstring from permission set


acl_clear_prefetch($user_id = false)   X-Ref
Clear one or all users cached permission settings


acl_role_data($user_type, $role_type, $ug_id = false, $forum_id = false)   X-Ref
Get assigned roles


acl_raw_data($user_id = false, $opts = false, $forum_id = false)   X-Ref
Get raw acl data based on user/option/forum


acl_user_raw_data($user_id = false, $opts = false, $forum_id = false)   X-Ref
Get raw user based permission settings


acl_group_raw_data($group_id = false, $opts = false, $forum_id = false)   X-Ref
Get raw group based permission settings


acl_raw_data_single_user($user_id)   X-Ref
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.


_set_group_hold_ary(&$hold_ary, $option_id, $setting)   X-Ref
Private function snippet for setting a specific piece of the hold_ary


login($username, $password, $autologin = false, $viewonline = 1, $admin = 0)   X-Ref
Authentication plug-ins is largely down to Sergey Kanareykin, our thanks to him.


build_auth_option_statement($key, $auth_options, &$sql_opts)   X-Ref
Fill auth_option statement for later querying based on the supplied options




Generated: Tue Apr 7 19:44:41 2020 Cross-referenced by PHPXref 0.7.1