[ Index ]

PHP Cross Reference of Drupal 6 (gatewave)

title

Body

[close]

/modules/user/ -> user.module (summary)

(no description)

File Size: 2546 lines (94 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 82 functions

  user_module_invoke()
  user_theme()
  user_external_load()
  user_external_login()
  user_load()
  user_save()
  user_validate_name()
  user_validate_mail()
  user_validate_picture()
  user_password()
  user_access()
  user_is_blocked()
  user_fields()
  user_perm()
  user_file_download()
  user_search()
  user_elements()
  user_user()
  user_login_block()
  user_block()
  template_preprocess_user_picture()
  theme_user_list()
  user_is_anonymous()
  user_is_logged_in()
  user_register_access()
  user_view_access()
  user_edit_access()
  user_load_self()
  user_menu()
  user_init()
  user_uid_optional_load()
  user_category_load()
  user_uid_optional_to_arg()
  user_page_title()
  user_get_authmaps()
  user_set_authmaps()
  user_login()
  user_login_default_validators()
  user_login_name_validate()
  user_login_authenticate_validate()
  user_login_final_validate()
  user_authenticate()
  user_authenticate_finalize()
  user_login_submit()
  user_external_login_register()
  user_pass_reset_url()
  user_pass_rehash()
  user_edit_form()
  _user_edit_validate()
  _user_edit_submit()
  user_delete()
  user_build_content()
  user_mail()
  _user_mail_text()
  user_roles()
  user_user_operations()
  user_user_operations_unblock()
  user_user_operations_block()
  user_multiple_role_edit()
  user_multiple_delete_confirm()
  user_multiple_delete_confirm_submit()
  user_help()
  _user_categories()
  _user_sort()
  user_filters()
  user_build_filter_query()
  user_forms()
  user_comment()
  theme_user_signature()
  user_mail_tokens()
  user_preferred_language()
  _user_mail_notify()
  _user_password_dynamic_validation()
  user_hook_info()
  user_action_info()
  user_block_user_action()
  user_block_ip_action()
  user_register_submit()
  user_register()
  user_register_validate()
  _user_forms()
  user_login_destination()

Functions
Functions that are not part of a class:

user_module_invoke($type, &$array, &$user, $category = NULL)   X-Ref
Invokes hook_user() in every module.

We cannot use module_invoke() for this, because the arguments need to
be passed by reference.

user_theme()   X-Ref
Implementation of hook_theme().


user_external_load($authname)   X-Ref
No description

user_external_login($account, $edit = array()   X-Ref
Perform standard Drupal login operations for a user object.

The user object must already be authenticated. This function verifies
that the user account is not blocked/denied and then performs the login,
updates the login timestamp in the database, invokes hook_user('login'),
and regenerates the session.

param: $account
param: $edit
return: boolean

user_load($user_info = array()   X-Ref
Fetch a user object.

param: $user_info
return:

user_save($account, $array = array()   X-Ref
Save changes to a user account or add a new user.

param: $account
param: $array
param: $category
return:

user_validate_name($name)   X-Ref
Verify the syntax of the given name.


user_validate_mail($mail)   X-Ref
No description

user_validate_picture(&$form, &$form_state)   X-Ref
No description

user_password($length = 10)   X-Ref
Generate a random alphanumeric password.


user_access($string, $account = NULL, $reset = FALSE)   X-Ref
Determine whether the user has a given privilege.

param: $string
param: $account
param: $reset
return:

user_is_blocked($name)   X-Ref
Checks for usernames blocked by user administration.

return: boolean TRUE for blocked users, FALSE for active.

user_fields()   X-Ref
No description

user_perm()   X-Ref
Implementation of hook_perm().


user_file_download($file)   X-Ref
Implementation of hook_file_download().

Ensure that user pictures (avatars) are always downloadable.

user_search($op = 'search', $keys = NULL, $skip_access_check = FALSE)   X-Ref
Implementation of hook_search().


user_elements()   X-Ref
Implementation of hook_elements().


user_user($type, &$edit, &$account, $category = NULL)   X-Ref
Implementation of hook_user().


user_login_block()   X-Ref
No description

user_block($op = 'list', $delta = 0, $edit = array()   X-Ref
Implementation of hook_block().


template_preprocess_user_picture(&$variables)   X-Ref
Process variables for user-picture.tpl.php.

The $variables array contains the following arguments:
- $account


theme_user_list($users, $title = NULL)   X-Ref
Make a list of users.

param: $users
param: $title

user_is_anonymous()   X-Ref
No description

user_is_logged_in()   X-Ref
No description

user_register_access()   X-Ref
No description

user_view_access($account)   X-Ref
No description

user_edit_access($account)   X-Ref
Access callback for user account editing.


user_load_self($arg)   X-Ref
No description

user_menu()   X-Ref
Implementation of hook_menu().


user_init()   X-Ref
Implementation of hook_init().


user_uid_optional_load($uid = NULL)   X-Ref
Load either a specified or the current user account.

param: $uid
return:

user_category_load($uid, &$map, $index)   X-Ref
Return a user object after checking if any profile category in the path exists.


user_uid_optional_to_arg($arg)   X-Ref
Returns the user id of the currently logged in user.


user_page_title($account)   X-Ref
Menu item title callback - use the user name if it's not the current user.


user_get_authmaps($authname = NULL)   X-Ref
Discover which external authentication module(s) authenticated a username.

param: $authname
return:

user_set_authmaps($account, $authmaps)   X-Ref
Save mappings of which external authentication module(s) authenticated
a user. Maps external usernames to user ids in the users table.

param: $account
param: $authmaps

user_login(&$form_state)   X-Ref
Form builder; the main user login form.


user_login_default_validators()   X-Ref
Set up a series for validators which check for blocked/denied users,
then authenticate against local database, then return an error if
authentication fails. Distributed authentication modules are welcome
to use hook_form_alter() to change this series in order to
authenticate against their user database instead of the local users
table.

We use three validators instead of one since external authentication
modules usually only need to alter the second validator.

return: array

user_login_name_validate($form, &$form_state)   X-Ref
A FAPI validate handler. Sets an error if supplied username has been blocked
or denied access.


user_login_authenticate_validate($form, &$form_state)   X-Ref
A validate handler on the login form. Check supplied username/password
against local users table. If successful, sets the global $user object.


user_login_final_validate($form, &$form_state)   X-Ref
A validate handler on the login form. Should be the last validator. Sets an
error if user has not been authenticated yet.


user_authenticate($form_values = array()   X-Ref
Try to log in the user locally.

param: $form_values
return:

user_authenticate_finalize(&$edit)   X-Ref
Finalize the login process. Must be called when logging in a user.

The function records a watchdog message about the new session, saves the
login timestamp, calls hook_user op 'login' and generates a new session.

$param $edit
This array is passed to hook_user op login.

user_login_submit($form, &$form_state)   X-Ref
Submit handler for the login form. Redirects the user to a page.

The user is redirected to the My Account page. Setting the destination in
the query string (as done by the user login block) overrides the redirect.

user_external_login_register($name, $module)   X-Ref
Helper function for authentication modules. Either login in or registers
the current user, based on username. Either way, the global $user object is
populated based on $name.


user_pass_reset_url($account)   X-Ref
Generates a unique URL for a user to login and reset their password.

param: object $account
return:

user_pass_rehash($password, $timestamp, $login)   X-Ref
No description

user_edit_form(&$form_state, $uid, $edit, $register = FALSE)   X-Ref
No description

_user_edit_validate($uid, &$edit)   X-Ref
No description

_user_edit_submit($uid, &$edit)   X-Ref
No description

user_delete($edit, $uid)   X-Ref
Delete a user.

param: $edit An array of submitted form values.
param: $uid The user ID of the user to delete.

user_build_content(&$account)   X-Ref
Builds a structured array representing the profile content.

param: $account
return:

user_mail($key, &$message, $params)   X-Ref
Implementation of hook_mail().


_user_mail_text($key, $language = NULL, $variables = array()   X-Ref
Returns a mail string for a variable name.

Used by user_mail() and the settings forms to retrieve strings.

user_roles($membersonly = FALSE, $permission = NULL)   X-Ref
Retrieve an array of roles matching specified conditions.

param: $membersonly
param: $permission
return:

user_user_operations($form_state = array()   X-Ref
Implementation of hook_user_operations().


user_user_operations_unblock($accounts)   X-Ref
Callback function for admin mass unblocking users.


user_user_operations_block($accounts)   X-Ref
Callback function for admin mass blocking users.


user_multiple_role_edit($accounts, $operation, $rid)   X-Ref
Callback function for admin mass adding/deleting a user role.


user_multiple_delete_confirm(&$form_state)   X-Ref
No description

user_multiple_delete_confirm_submit($form, &$form_state)   X-Ref
No description

user_help($path, $arg)   X-Ref
Implementation of hook_help().


_user_categories($account)   X-Ref
Retrieve a list of all user setting/information categories and sort them by weight.


_user_sort($a, $b)   X-Ref
No description

user_filters()   X-Ref
List user administration filters that can be applied.


user_build_filter_query()   X-Ref
Build query for user administration filters based on session.


user_forms()   X-Ref
Implementation of hook_forms().


user_comment(&$comment, $op)   X-Ref
Implementation of hook_comment().


theme_user_signature($signature)   X-Ref
Theme output of user signature.


user_mail_tokens($account, $language)   X-Ref
Return an array of token to value mappings for user e-mail messages.

param: $account
param: $language
return:

user_preferred_language($account, $default = NULL)   X-Ref
Get the language object preferred by the user. This user preference can
be set on the user account editing page, and is only available if there
are more than one languages enabled on the site. If the user did not
choose a preferred language, or is the anonymous user, the $default
value, or if it is not set, the site default language will be returned.

param: $account
param: $default

_user_mail_notify($op, $account, $language = NULL)   X-Ref
Conditionally create and send a notification email when a certain
operation happens on the given user account.

param: $op
param: $account
param: $language
return:

_user_password_dynamic_validation()   X-Ref
Add javascript and string translations for dynamic password validation
(strength and confirmation checking).

This is an internal function that makes it easier to manage the translation
strings that need to be passed to the javascript code.

user_hook_info()   X-Ref
Implementation of hook_hook_info().


user_action_info()   X-Ref
Implementation of hook_action_info().


user_block_user_action(&$object, $context = array()   X-Ref
Implementation of a Drupal action.
Blocks the current user.


user_block_ip_action()   X-Ref
Implementation of a Drupal action.
Adds an access rule that blocks the user's IP address.


user_register_submit($form, &$form_state)   X-Ref
Submit handler for the user registration form.

This function is shared by the installation form and the normal registration form,
which is why it can't be in the user.pages.inc file.

user_register()   X-Ref
Form builder; The user registration form.


user_register_validate($form, &$form_state)   X-Ref
No description

_user_forms(&$edit, $account, $category, $hook = 'form')   X-Ref
Retrieve a list of all form elements for the specified category.


user_login_destination()   X-Ref
Prepare a destination query string for use in combination with drupal_goto().

Used to direct the user back to the referring page after completing
the openid login.  This function prevents the login page from being
returned because that page will give an access denied message to an
authenticated user.




Generated: Thu Mar 24 11:18:33 2011 Cross-referenced by PHPXref 0.7