[ Index ]

PHP Cross Reference of MantisBT

title

Body

[close]

/core/ -> current_user_api.php (summary)

Current User 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: 234 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 15 functions

  current_user_get_access_level()
  current_user_get_assigned_open_bug_count()
  current_user_get_reported_open_bug_count()
  current_user_get_field()
  current_user_get_pref()
  current_user_set_pref()
  current_user_set_default_project()
  current_user_get_accessible_projects()
  current_user_get_accessible_subprojects()
  current_user_get_all_accessible_subprojects()
  current_user_is_administrator()
  current_user_is_protected()
  current_user_is_anonymous()
  current_user_ensure_unprotected()
  current_user_get_bug_filter()

Functions
Functions that are not part of a class:

current_user_get_access_level()   X-Ref
Returns the access level of the current user in the current project

return: access level code

current_user_get_assigned_open_bug_count()   X-Ref
Returns the number of open issues that are assigned to the current user
in the current project.

return: Number of issues assigned to current user that are still open.

current_user_get_reported_open_bug_count()   X-Ref
Returns the number of open reported bugs by the current user in
the current project

return: Number of issues reported by current user that are still open.

current_user_get_field( $p_field_name )   X-Ref
Returns the specified field of the currently logged in user

param: field_name  Name of user property as in the table definition.
return: Get the value of the specified field for current user.

current_user_get_pref( $p_pref_name )   X-Ref
Returns the specified field of the currently logged in user

param: pref_name    Name of user preference as in the preferences table
return: Get the value of the specified preference for current user.

current_user_set_pref( $p_pref_name, $p_pref_value )   X-Ref
Sets the specified preference for the current logged in user.

param: pref_name        The name of the preference as in the preferences table.
param: pref_value    The preference new value.

current_user_set_default_project( $p_project_id )   X-Ref
Return the specified field of the currently logged in user

param: project_id    The new default project id.

current_user_get_accessible_projects( $p_show_disabled = false )   X-Ref
Returns an array of projects that are accessible to the current logged in
user.

param: show_disabled    Include disabled projects.
return: an array of accessible project ids.

current_user_get_accessible_subprojects( $p_project_id, $p_show_disabled = false )   X-Ref
Returns an array of subprojects of the specified project to which the
currently logged in user has access to.

param: project_id    Parent project id.
param: show_disabled    Include disabled projects.
return: an array of accessible sub-project ids.

current_user_get_all_accessible_subprojects( $p_project_id )   X-Ref
Returns an array of subprojects of the specified project to which the
currently logged in user has access, including subprojects of subprojects

param: project_id    Parent project id.
return: an array of accessible sub-project ids.

current_user_is_administrator()   X-Ref
Returns true if the currently logged in user is has a role of administrator
or higher, false otherwise

return: true: administrator; false: otherwise.

current_user_is_protected()   X-Ref
Returns true if the current user is a protected user, false otherwise.
The $g_anonymous_account user is always considered protected.

return: true: user is protected; false: otherwise.

current_user_is_anonymous()   X-Ref
Returns true if the current user is the anonymous user.

return: true: user is anonymous; false: otherwise.

current_user_ensure_unprotected()   X-Ref
Triggers an ERROR if the current user account is protected.
The $g_anonymous_account user is always considered protected.


current_user_get_bug_filter( $p_project_id = null )   X-Ref
Returns the issue filter parameters for the current user

return: Active issue filter for current user or false if no filter is currently defined.



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