[ Index ]

PHP Cross Reference of MantisBT

title

Body

[close]

/core/ -> profile_api.php (summary)

Profile API

Copyright: Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
Copyright: Copyright (C) 2002 - 2011 MantisBT Team - mantisbt-dev@lists.sourceforge.net
File Size: 352 lines (10 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 11 functions

  profile_create()
  profile_delete()
  profile_update()
  profile_get_row()
  profile_get_row_direct()
  profile_get_all_rows()
  profile_get_all_for_user()
  profile_get_field_all_for_user()
  profile_get_all_for_project()
  profile_get_default()
  profile_is_global()

Functions
Functions that are not part of a class:

profile_create( $p_user_id, $p_platform, $p_os, $p_os_build, $p_description )   X-Ref
Create a new profile for the user, return the ID of the new profile

param: int $p_user_id
param: string $p_platform
param: string $p_os
param: string $p_os_build
param: string $p_description
return: int

profile_delete( $p_user_id, $p_profile_id )   X-Ref
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
param: int $p_user_id
param: int $p_profile_id
return: true

profile_update( $p_user_id, $p_profile_id, $p_platform, $p_os, $p_os_build, $p_description )   X-Ref
Update a profile for the user

param: int $p_user_id
param: int $p_profile_id
param: string $p_platform
param: string $p_os
param: string $p_os_build
param: string $p_description
return: true

profile_get_row( $p_user_id, $p_profile_id )   X-Ref
Return a profile row from the database

param: int $p_user_id
param: int $p_profile_id
return: array

profile_get_row_direct( $p_profile_id )   X-Ref
Return a profile row from the database

param: int $p_profile_id
return: array

profile_get_all_rows( $p_user_id )   X-Ref
Return an array containing all rows for a given user

param: int $p_user_id
return: array

profile_get_all_for_user( $p_user_id )   X-Ref
Return an array containing all profiles for a given user,
including global profiles

param: int $p_user_id
return: array

profile_get_field_all_for_user( $p_field, $p_user_id = null )   X-Ref
Return an array of strings containing unique values for the specified field based
on private and public profiles accessible to the specified user.

param: string $p_field
param: int $p_user_id
return: array

profile_get_all_for_project( $p_project_id )   X-Ref
Return an array containing all profiles used in a given project

param: int $p_project_id
return: array

profile_get_default( $p_user_id )   X-Ref
Returns the default profile

param: int $p_user_id
return: string

profile_is_global( $p_profile_id )   X-Ref
Returns whether the specified profile is global

param: int $p_profile_id
return: bool



Generated: Thu Jul 28 15:48:31 2011 Cross-referenced by PHPXref 0.7