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

Procedural File: profile_api.php

Source Location: /core/profile_api.php



Page Details:



Tags:

copyright:  Copyright (C) 2002 - 2010 MantisBT Team - mantisbt-dev@lists.sourceforge.net
copyright:  Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
link:  http://www.mantisbt.org








profile_create [line 34]

int profile_create( int $p_user_id, string $p_platform, string $p_os, string $p_os_build, string $p_description)

Create a new profile for the user, return the ID of the new profile



Parameters

int   $p_user_id  
string   $p_platform  
string   $p_os  
string   $p_os_build  
string   $p_description  
[ Top ]



profile_delete [line 81]

true profile_delete( int $p_user_id, int $p_profile_id)

Delete a profile for the user

Note that although profile IDs are currently globally unique, the existing code included the user_id in the query and I have chosen to keep that for this API as it hides the details of id implementation from users of the API




Parameters

int   $p_user_id  
int   $p_profile_id  
[ Top ]



profile_get_all_for_project [line 280]

array profile_get_all_for_project( int $p_project_id)

Return an array containing all profiles used in a given project



Parameters

int   $p_project_id  
[ Top ]



profile_get_all_for_user [line 222]

array profile_get_all_for_user( int $p_user_id)

Return an array containing all profiles for a given user,

including global profiles




Parameters

int   $p_user_id  
[ Top ]



profile_get_all_rows [line 195]

array profile_get_all_rows( int $p_user_id)

Return an array containing all rows for a given user



Parameters

int   $p_user_id  
[ Top ]



profile_get_default [line 309]

string profile_get_default( int $p_user_id)

Returns the default profile



Parameters

int   $p_user_id  
[ Top ]



profile_get_field_all_for_user [line 239]

array profile_get_field_all_for_user( string $p_field, [int $p_user_id = null])

Return an array of strings containing unique values for the specified field based on private and public profiles accessible to the specified user.



Parameters

string   $p_field  
int   $p_user_id  
[ Top ]



profile_get_row [line 157]

array profile_get_row( int $p_user_id, int $p_profile_id)

Return a profile row from the database



Parameters

int   $p_user_id  
int   $p_profile_id  
[ Top ]



profile_get_row_direct [line 177]

array profile_get_row_direct( int $p_profile_id)

Return a profile row from the database



Tags:

todo:  relationship of this function to profile_get_row?


Parameters

int   $p_profile_id  
[ Top ]



profile_is_global [line 328]

bool profile_is_global( int $p_profile_id)

Returns whether the specified profile is global



Parameters

int   $p_profile_id  
[ Top ]



profile_update [line 110]

true profile_update( int $p_user_id, int $p_profile_id, string $p_platform, string $p_os, string $p_os_build, string $p_description)

Update a profile for the user



Parameters

int   $p_user_id  
int   $p_profile_id  
string   $p_platform  
string   $p_os  
string   $p_os_build  
string   $p_description  
[ Top ]



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