[ Index ]

PHP Cross Reference of phpBB 3.0 Beta 3

title

Body

[close]

/includes/ -> functions_user.php (summary)

(no description)

Copyright: (c) 2005 phpBB Group
License: http://opensource.org/licenses/gpl-license.php GNU Public License
Version: $Id: functions_user.php,v 1.146 2006/11/12 15:35:43 acydburn Exp $
File Size: 2278 lines (58 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 29 functions

  user_get_id_name()
  update_last_username()
  user_update_name()
  user_add()
  user_delete()
  user_active_flip()
  user_ban()
  user_unban()
  user_ipwhois()
  validate_data()
  validate_string()
  validate_num()
  validate_match()
  validate_username()
  validate_password()
  validate_email()
  avatar_delete()
  avatar_remote()
  avatar_upload()
  avatar_gallery()
  group_create()
  group_delete()
  group_user_add()
  group_user_del()
  group_user_attributes()
  group_set_user_default()
  get_group_name()
  group_memberships()
  group_update_listings()

Functions
Functions that are not part of a class:

user_get_id_name(&$user_id_ary, &$username_ary, $only_active = false)   X-Ref
Obtain user_ids from usernames or vice versa. Returns false on
success else the error string


update_last_username()   X-Ref
Get latest registered username and update database to reflect it


user_update_name($old_name, $new_name)   X-Ref
Updates a username across all relevant tables/fields

param: string $old_name the old/current username
param: string $new_name the new username

user_add($user_row, $cp_data = false)   X-Ref
Add User


user_delete($mode, $user_id, $post_username = false)   X-Ref
Remove User


user_active_flip($mode, $user_id_ary, $reason = INACTIVE_MANUAL)   X-Ref
Flips user_type from active to inactive and vice versa, handles group membership updates

param: string $mode can be flip for flipping from active/inactive, activate or deactivate

user_ban($mode, $ban, $ban_len, $ban_len_other, $ban_exclude, $ban_reason, $ban_give_reason = '')   X-Ref
Add a ban or ban exclusion to the banlist. Bans either a user, an IP or an email address

param: string $mode Type of ban. One of the following: user, ip, email
param: mixed $ban Banned entity. Either string or array with usernames, ips or email addresses
param: int $ban_len Ban length in minutes
param: string $ban_len_other Ban length as a date (YYYY-MM-DD)
param: boolean $ban_exclude Exclude these entities from banning?
param: string $ban_reason String describing the reason for this ban
return: boolean

user_unban($mode, $ban)   X-Ref
Unban User


user_ipwhois($ip)   X-Ref
Whois facility


validate_data($data, $val_ary)   X-Ref
Data validation ... used primarily but not exclusively by ucp modules

"Master" function for validating a range of data types

validate_string($string, $optional = false, $min = 0, $max = 0)   X-Ref
Validate String

return: boolean|string    Either false if validation succeeded or a string which will be used as the error message (with the variable name appended)

validate_num($num, $optional = false, $min = 0, $max = 1E99)   X-Ref
Validate Number

return: boolean|string    Either false if validation succeeded or a string which will be used as the error message (with the variable name appended)

validate_match($string, $optional = false, $match)   X-Ref
Validate Match

return: boolean|string    Either false if validation succeeded or a string which will be used as the error message (with the variable name appended)

validate_username($username)   X-Ref
Check to see if the username has been taken, or if it is disallowed.
Also checks if it includes the " character, which we don't allow in usernames.
Used for registering, changing names, and posting anonymously with a username

return: boolean|string    Either false if validation succeeded or a string which will be used as the error message (with the variable name appended)

validate_password($password)   X-Ref
Check to see if the password meets the complexity settings

return: boolean|string    Either false if validation succeeded or a string which will be used as the error message (with the variable name appended)

validate_email($email)   X-Ref
Check to see if email address is banned or already present in the DB

return: boolean|string    Either false if validation succeeded or a string which will be used as the error message (with the variable name appended)

avatar_delete($mode, $row)   X-Ref
Remove avatar


avatar_remote($data, &$error)   X-Ref
Remote avatar linkage


avatar_upload($data, &$error)   X-Ref
Avatar upload using the upload class


avatar_gallery($category, $avatar_select, $items_per_column, $block_var = 'avatar_row')   X-Ref
Avatar Gallery


group_create(&$group_id, $type, $name, $desc, $group_attributes, $allow_desc_bbcode = false, $allow_desc_urls = false, $allow_desc_smilies = false)   X-Ref
Add or edit a group. If we're editing a group we only update user
parameters such as rank, etc. if they are changed


group_delete($group_id, $group_name = false)   X-Ref
Group Delete


group_user_add($group_id, $user_id_ary = false, $username_ary = false, $group_name = false, $default = false, $leader = 0, $pending = 0, $group_attributes = false)   X-Ref
Add user(s) to group

return: false if no errors occurred, else the user lang string for the relevant error, for example 'NO_USER'

group_user_del($group_id, $user_id_ary = false, $username_ary = false, $group_name = false)   X-Ref
Remove a user/s from a given group. When we remove users we update their
default group_id. We do this by examining which "special" groups they belong
to. The selection is made based on a reasonable priority system

return: false if no errors occurred, else the user lang string for the relevant error, for example 'NO_USER'

group_user_attributes($action, $group_id, $user_id_ary = false, $username_ary = false, $group_name = false, $group_attributes = false)   X-Ref
This is used to promote (to leader), demote or set as default a member/s


group_set_user_default($group_id, $user_id_ary, $group_attributes = false)   X-Ref
Set users default group


get_group_name($group_id)   X-Ref
Get group name


group_memberships($group_id_ary = false, $user_id_ary = false, $return_bool = false)   X-Ref
Obtain either the members of a specified group, the groups the specified user is subscribed to
or checking if a specified user is in a specified group

Note: Never use this more than once... first group your users/groups

group_update_listings($group_id)   X-Ref
Re-cache moderators and foes if group has a_ or m_ permissions




Generated: Wed Nov 22 00:35:05 2006 Cross-referenced by PHPXref 0.6