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

Procedural File: user_api.php

Source Location: /core/user_api.php

Page Details

User API

Copyright:  Copyright (C) 2002 - 2009 MantisBT Team - mantisbt-dev@lists.sourceforge.net
Copyright:  Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
Usedby:  bug_monitor()
Includes
require_once ($t_core_dir.'ldap_api.php') [line 28]
[ Top ]

require_once ($t_core_dir.'email_api.php') [line 27]
[ Top ]


Functions
user_cache_array_rows  [line 76]

void user_cache_array_rows( $p_user_id_array  )
Parameters:
   $p_user_id_array: 


[ Top ]
user_cache_database_result  [line 106]

void user_cache_database_result( $p_user_database_result  )
Parameters:
   $p_user_database_result: 


[ Top ]
user_cache_row  [line 44]

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


[ Top ]
user_clear_cache  [line 118]

void user_clear_cache( [ $p_user_id = null]  )
Parameters:
   $p_user_id: 


[ Top ]
user_count_level  [line 378]

void user_count_level( [ $p_level = ANYBODY]  )
Parameters:
   $p_level: 


[ Top ]
user_create  [line 429]

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


[ Top ]
user_delete  [line 564]

void user_delete( $p_user_id  )
Parameters:
   $p_user_id: 


[ Top ]
user_delete_profiles  [line 544]

void user_delete_profiles( $p_user_id  )
Parameters:
   $p_user_id: 


[ Top ]
user_delete_project_specific_access_levels  [line 525]

void user_delete_project_specific_access_levels( $p_user_id  )
Parameters:
   $p_user_id: 


[ Top ]
user_ensure_exists  [line 175]

void user_ensure_exists( $p_user_id  )
Parameters:
   $p_user_id: 


[ Top ]
user_ensure_name_unique  [line 206]

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 360]

void user_ensure_unprotected( $p_user_id  )
Parameters:
   $p_user_id: 


[ Top ]
user_exists  [line 161]

void user_exists( $p_user_id  )
Parameters:
   $p_user_id: 


[ Top ]
user_get_accessible_projects  [line 826]

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 895]

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 806]

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 986]

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 968]

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 1006]

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 773]

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

Parameters:
   $p_user_id: 
   $p_size: 

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


[ Top ]
user_get_bug_filter  [line 1086]

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


[ Top ]
user_get_email  [line 724]

void user_get_email( $p_user_id  )
Parameters:
   $p_user_id: 


[ Top ]
user_get_field  [line 705]

void user_get_field( $p_user_id, $p_field_name  )
Parameters:
   $p_user_id: 
   $p_field_name: 


[ Top ]
user_get_id_by_email  [line 637]

void user_get_id_by_email( $p_email  )
Parameters:
   $p_email: 


[ Top ]
user_get_id_by_name  [line 614]

void user_get_id_by_name( $p_username  )
Parameters:
   $p_username: 


[ Top ]
user_get_id_by_realname  [line 660]

void user_get_id_by_realname( $p_realname  )
Parameters:
   $p_realname: 


[ Top ]
user_get_logged_in_user_ids  [line 395]

void user_get_logged_in_user_ids( $p_session_duration_in_minutes  )
Parameters:
   $p_session_duration_in_minutes: 


[ Top ]
user_get_name  [line 746]

void user_get_name( $p_user_id  )
Parameters:
   $p_user_id: 


[ Top ]
user_get_profile_row  [line 1044]

void user_get_profile_row( $p_user_id, $p_profile_id  )
Parameters:
   $p_user_id: 
   $p_profile_id: 


[ Top ]
user_get_realname  [line 737]

void user_get_realname( $p_user_id  )
Parameters:
   $p_user_id: 


[ Top ]
user_get_reported_open_bug_count  [line 1025]

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 699]

void user_get_row( $p_user_id  )
Parameters:
   $p_user_id: 


[ Top ]
user_get_row_by_name  [line 685]

void user_get_row_by_name( $p_username  )
Parameters:
   $p_username: 


[ Top ]
user_increment_failed_login_count  [line 1166]

void user_increment_failed_login_count( $p_user_id  )
Parameters:
   $p_user_id: 


[ Top ]
user_increment_login_count  [line 1134]

void user_increment_login_count( $p_user_id  )
Parameters:
   $p_user_id: 


[ Top ]
user_increment_lost_password_in_progress_count  [line 1196]

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_enabled  [line 368]

void user_is_enabled( $p_user_id  )
Parameters:
   $p_user_id: 


[ Top ]
user_is_login_request_allowed  [line 1067]

void user_is_login_request_allowed( $p_user_id  )
Parameters:
   $p_user_id: 


[ Top ]
user_is_lost_password_request_allowed  [line 1075]

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 187]

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 350]

void user_is_protected( $p_user_id  )
Parameters:
   $p_user_id: 


[ Top ]
user_is_realname_unique  [line 215]

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 1151]

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 1181]

void user_reset_lost_password_in_progress_count_to_zero( $p_user_id  )
Parameters:
   $p_user_id: 


[ Top ]
user_reset_password  [line 1302]

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


[ Top ]
user_search_cache  [line 140]

void user_search_cache( $p_field, $p_value  )
Parameters:
   $p_field: 
   $p_value: 


[ Top ]
user_set_default_project  [line 1236]

void user_set_default_project( $p_user_id, $p_project_id  )
Parameters:
   $p_user_id: 
   $p_project_id: 


[ Top ]
user_set_email  [line 1271]

void user_set_email( $p_user_id, $p_email  )
Parameters:
   $p_user_id: 
   $p_email: 


[ Top ]
user_set_field  [line 1211]

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 1287]

void user_set_name( $p_user_id, $p_username  )
Parameters:
   $p_user_id: 
   $p_username: 


[ Top ]
user_set_password  [line 1242]

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 1279]

void user_set_realname( $p_user_id, $p_realname  )
Parameters:
   $p_user_id: 
   $p_realname: 


[ Top ]
user_signup  [line 486]

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


[ Top ]
user_update_cache  [line 130]

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 1113]

void user_update_last_visit( $p_user_id  )
Parameters:
   $p_user_id: 


[ Top ]


Documentation generated on Sun, 05 Apr 2009 23:01:37 +0100 by phpDocumentor 1.4.1