CoreAPI
[ class tree: CoreAPI ] [ index: CoreAPI ] [ all elements ]

Procedural File: user_api.php

Source Location: /core/user_api.php



Page Details:

User API



Tags:

copyright:  Copyright (C) 2002 - 2010 MantisBT Team - mantisbt-dev@lists.sourceforge.net
copyright:  Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
usedby:  bug_monitor_copy()
usedby:  bug_monitor()


Includes:

require_once('ldap_api.php') [line 32]
requires ldap_api

require_once('email_api.php') [line 28]
requires email_api







user_cache_array_rows [line 80]

void user_cache_array_rows( $p_user_id_array)



Parameters

   $p_user_id_array  
[ Top ]



user_cache_database_result [line 109]

void user_cache_database_result( $p_user_database_result)



Parameters

   $p_user_database_result  
[ Top ]



user_cache_row [line 48]

void user_cache_row( $p_user_id, [ $p_trigger_errors = true])



Parameters

   $p_user_id  
   $p_trigger_errors  
[ Top ]



user_clear_cache [line 121]

void user_clear_cache( [ $p_user_id = null])



Parameters

   $p_user_id  
[ Top ]



user_count_level [line 401]

void user_count_level( [ $p_level = ANYBODY])



Parameters

   $p_level  
[ Top ]



user_create [line 450]

void user_create( $p_username, $p_password, [ $p_email = ''], [ $p_access_level = null], [ $p_protected = false], [ $p_enabled = true], [ $p_realname = ''], [ $p_admin_name = ''])



Parameters

   $p_username  
   $p_password  
   $p_email  
   $p_access_level  
   $p_protected  
   $p_enabled  
   $p_realname  
   $p_admin_name  
[ Top ]



user_delete [line 582]

void user_delete( $p_user_id)



Parameters

   $p_user_id  
[ Top ]



user_delete_profiles [line 562]

void user_delete_profiles( $p_user_id)



Parameters

   $p_user_id  
[ Top ]



user_delete_project_specific_access_levels [line 543]

void user_delete_project_specific_access_levels( $p_user_id)



Parameters

   $p_user_id  
[ Top ]



user_ensure_exists [line 178]

void user_ensure_exists( $p_user_id)



Parameters

   $p_user_id  
[ Top ]



user_ensure_name_unique [line 207]

void user_ensure_name_unique( $p_username)



Parameters

   $p_username  
[ Top ]



user_ensure_name_valid [line 309]

void user_ensure_name_valid( $p_username)



Parameters

   $p_username  
[ Top ]



user_ensure_realname_unique [line 260]

void user_ensure_realname_unique( $p_username, $p_realname)



Parameters

   $p_username  
   $p_realname  
[ Top ]



user_ensure_realname_valid [line 275]

void user_ensure_realname_valid( $p_realname)



Parameters

   $p_realname  
[ Top ]



user_ensure_unprotected [line 383]

void user_ensure_unprotected( $p_user_id)



Parameters

   $p_user_id  
[ Top ]



user_exists [line 164]

void user_exists( $p_user_id)



Parameters

   $p_user_id  
[ Top ]



user_get_accessible_projects [line 852]

void user_get_accessible_projects( $p_user_id, [ $p_show_disabled = false])



Parameters

   $p_user_id  
   $p_show_disabled  
[ Top ]



user_get_accessible_subprojects [line 921]

void user_get_accessible_subprojects( $p_user_id, $p_project_id, [ $p_show_disabled = false])



Parameters

   $p_user_id  
   $p_project_id  
   $p_show_disabled  
[ Top ]



user_get_access_level [line 832]

void user_get_access_level( $p_user_id, [ $p_project_id = ALL_PROJECTS])



Parameters

   $p_user_id  
   $p_project_id  
[ Top ]



user_get_all_accessible_projects [line 1011]

void user_get_all_accessible_projects( $p_user_id, $p_project_id)



Parameters

   $p_user_id  
   $p_project_id  
[ Top ]



user_get_all_accessible_subprojects [line 993]

void user_get_all_accessible_subprojects( $p_user_id, $p_project_id)



Parameters

   $p_user_id  
   $p_project_id  
[ Top ]



user_get_assigned_open_bug_count [line 1031]

void user_get_assigned_open_bug_count( $p_user_id, [ $p_project_id = ALL_PROJECTS])



Parameters

   $p_user_id  
   $p_project_id  
[ Top ]



user_get_avatar [line 799]

array|bool user_get_avatar( $p_user_id, [ $p_size = 80])

Return the user avatar image URL

in this first implementation, only gravatar.com avatars are supported




Tags:

return:  an array( URL, width, height ) or false when the given user has no avatar


Parameters

   $p_user_id  
   $p_size  
[ Top ]



user_get_bug_filter [line 1111]

void user_get_bug_filter( $p_user_id, [ $p_project_id = null])



Parameters

   $p_user_id  
   $p_project_id  
[ Top ]



user_get_email [line 742]

void user_get_email( $p_user_id)



Parameters

   $p_user_id  
[ Top ]



user_get_field [line 723]

void user_get_field( $p_user_id, $p_field_name)



Parameters

   $p_user_id  
   $p_field_name  
[ Top ]



user_get_id_by_email [line 655]

void user_get_id_by_email( $p_email)



Parameters

   $p_email  
[ Top ]



user_get_id_by_name [line 632]

void user_get_id_by_name( $p_username)



Parameters

   $p_username  
[ Top ]



user_get_id_by_realname [line 678]

void user_get_id_by_realname( $p_realname)



Parameters

   $p_realname  
[ Top ]



user_get_logged_in_user_ids [line 418]

void user_get_logged_in_user_ids( $p_session_duration_in_minutes)



Parameters

   $p_session_duration_in_minutes  
[ Top ]



user_get_name [line 772]

void user_get_name( $p_user_id)



Parameters

   $p_user_id  
[ Top ]



user_get_profile_row [line 1069]

void user_get_profile_row( $p_user_id, $p_profile_id)



Parameters

   $p_user_id  
   $p_profile_id  
[ Top ]



user_get_realname [line 755]

void user_get_realname( $p_user_id)



Parameters

   $p_user_id  
[ Top ]



user_get_reported_open_bug_count [line 1050]

void user_get_reported_open_bug_count( $p_user_id, [ $p_project_id = ALL_PROJECTS])



Parameters

   $p_user_id  
   $p_project_id  
[ Top ]



user_get_row [line 717]

void user_get_row( $p_user_id)



Parameters

   $p_user_id  
[ Top ]



user_get_row_by_name [line 703]

void user_get_row_by_name( $p_username)



Parameters

   $p_username  
[ Top ]



user_increment_failed_login_count [line 1191]

void user_increment_failed_login_count( $p_user_id)



Parameters

   $p_user_id  
[ Top ]



user_increment_login_count [line 1159]

void user_increment_login_count( $p_user_id)



Parameters

   $p_user_id  
[ Top ]



user_increment_lost_password_in_progress_count [line 1221]

void user_increment_lost_password_in_progress_count( $p_user_id)



Parameters

   $p_user_id  
[ Top ]



user_is_administrator [line 338]

void user_is_administrator( $p_user_id)



Parameters

   $p_user_id  
[ Top ]



user_is_anonymous [line 374]

void user_is_anonymous( $p_user_id)



Parameters

   $p_user_id  
[ Top ]



user_is_enabled [line 391]

void user_is_enabled( $p_user_id)



Parameters

   $p_user_id  
[ Top ]



user_is_login_request_allowed [line 1092]

void user_is_login_request_allowed( $p_user_id)



Parameters

   $p_user_id  
[ Top ]



user_is_lost_password_request_allowed [line 1100]

void user_is_lost_password_request_allowed( $p_user_id)



Parameters

   $p_user_id  
[ Top ]



user_is_monitoring_bug [line 317]

void user_is_monitoring_bug( $p_user_id, $p_bug_id)



Parameters

   $p_user_id  
   $p_bug_id  
[ Top ]



user_is_name_unique [line 190]

void user_is_name_unique( $p_username)



Parameters

   $p_username  
[ Top ]



user_is_name_valid [line 285]

void user_is_name_valid( $p_username)



Parameters

   $p_username  
[ Top ]



user_is_protected [line 359]

void user_is_protected( $p_user_id)



Parameters

   $p_user_id  
[ Top ]



user_is_realname_unique [line 216]

void user_is_realname_unique( $p_username, $p_realname)



Parameters

   $p_username  
   $p_realname  
[ Top ]



user_is_realname_valid [line 269]

void user_is_realname_valid( $p_realname)



Parameters

   $p_realname  
[ Top ]



user_reset_failed_login_count_to_zero [line 1176]

void user_reset_failed_login_count_to_zero( $p_user_id)



Parameters

   $p_user_id  
[ Top ]



user_reset_lost_password_in_progress_count_to_zero [line 1206]

void user_reset_lost_password_in_progress_count_to_zero( $p_user_id)



Parameters

   $p_user_id  
[ Top ]



user_reset_password [line 1326]

void user_reset_password( $p_user_id, [ $p_send_email = true])



Parameters

   $p_user_id  
   $p_send_email  
[ Top ]



user_search_cache [line 143]

void user_search_cache( $p_field, $p_value)



Parameters

   $p_field  
   $p_value  
[ Top ]



user_set_default_project [line 1260]

void user_set_default_project( $p_user_id, $p_project_id)



Parameters

   $p_user_id  
   $p_project_id  
[ Top ]



user_set_email [line 1295]

void user_set_email( $p_user_id, $p_email)



Parameters

   $p_user_id  
   $p_email  
[ Top ]



user_set_field [line 1236]

void user_set_field( $p_user_id, $p_field_name, $p_field_value)



Parameters

   $p_user_id  
   $p_field_name  
   $p_field_value  
[ Top ]



user_set_name [line 1311]

void user_set_name( $p_user_id, $p_username)



Parameters

   $p_user_id  
   $p_username  
[ Top ]



user_set_password [line 1266]

void user_set_password( $p_user_id, $p_password, [ $p_allow_protected = false])



Parameters

   $p_user_id  
   $p_password  
   $p_allow_protected  
[ Top ]



user_set_realname [line 1303]

void user_set_realname( $p_user_id, $p_realname)



Parameters

   $p_user_id  
   $p_realname  
[ Top ]



user_signup [line 504]

void user_signup( $p_username, [ $p_email = null])



Parameters

   $p_username  
   $p_email  
[ Top ]



user_update_cache [line 133]

void user_update_cache( $p_user_id, $p_field, $p_value)



Parameters

   $p_user_id  
   $p_field  
   $p_value  
[ Top ]



user_update_last_visit [line 1138]

void user_update_last_visit( $p_user_id)



Parameters

   $p_user_id  
[ Top ]



Documentation generated on Sun, 12 Dec 2010 23:50:53 +0900 by phpDocumentor 1.4.3
inserted by FC2 system