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

Procedural File: current_user_api.php

Source Location: /core/current_user_api.php

Page Details
Copyright:  Copyright (C) 2002 - 2009 MantisBT Team - mantisbt-dev@lists.sourceforge.net
Copyright:  Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
Link:  http://www.mantisbt.org
Usedby:  collapse_api.php
Includes
require_once ($t_core_dir.'filter_api.php') [line 30]

requires filter_api

[ Top ]


Functions
current_user_ensure_unprotected  [line 187]

void current_user_ensure_unprotected( )

Triggers an ERROR if the current user account is protected


API Tags:
Access:  public


[ Top ]
current_user_get_accessible_projects  [line 118]

an current_user_get_accessible_projects( [show_disabled $p_show_disabled = false]  )

Returns an array of projects that are accessible to the current logged in user.

Parameters:
show_disabled   $p_show_disabled:  Include disabled projects.

API Tags:
Return:  array of accessible project ids.
Access:  public


[ Top ]
current_user_get_accessible_subprojects  [line 131]

an current_user_get_accessible_subprojects( project_id $p_project_id, [show_disabled $p_show_disabled = false]  )

Returns an array of subprojects of the specified project to which the currently logged in user has access to.

Parameters:
project_id   $p_project_id:  Parent project id.
show_disabled   $p_show_disabled:  Include disabled projects.

API Tags:
Return:  array of accessible sub-project ids.
Access:  public


[ Top ]
current_user_get_access_level  [line 40]

access current_user_get_access_level( )

Returns the access level of the current user in the current project


API Tags:
Return:  level code
Access:  public


[ Top ]
current_user_get_all_accessible_subprojects  [line 143]

an current_user_get_all_accessible_subprojects( project_id $p_project_id  )

Returns an array of subprojects of the specified project to which the currently logged in user has access, including subprojects of subprojects

Parameters:
project_id   $p_project_id:  Parent project id.

API Tags:
Return:  array of accessible sub-project ids.
Access:  public


[ Top ]
current_user_get_assigned_open_bug_count  [line 51]

Number current_user_get_assigned_open_bug_count( )

Returns the number of open issues that are assigned to the current user in the current project.


API Tags:
Return:  of issues assigned to current user that are still open.
Access:  public


[ Top ]
current_user_get_bug_filter  [line 197]

Active current_user_get_bug_filter( [ $p_project_id = null]  )

Returns the issue filter parameters for the current user

Parameters:
   $p_project_id: 

API Tags:
Return:  issue filter for current user.
Access:  public


[ Top ]
current_user_get_field  [line 73]

Get current_user_get_field( field_name $p_field_name  )

Returns the specified field of the currently logged in user

Parameters:
field_name   $p_field_name:  Name of user property as in the table definition.

API Tags:
Return:  the value of the specified field for current user.
Access:  public


[ Top ]
current_user_get_pref  [line 85]

Get current_user_get_pref( pref_name $p_pref_name  )

Returns the specified field of the currently logged in user

Parameters:
pref_name   $p_pref_name:  Name of user preference as in the preferences table definition.

API Tags:
Return:  the value of the specified preference for current user.
Access:  public


[ Top ]
current_user_get_reported_open_bug_count  [line 62]

Number current_user_get_reported_open_bug_count( )

Returns the number of open reported bugs by the current user in the current project


API Tags:
Return:  of issues reported by current user that are still open.
Access:  public


[ Top ]
current_user_is_administrator  [line 154]

true: current_user_is_administrator( )

Returns true if the currently logged in user is has a role of administrator or higher, false otherwise


API Tags:
Return:  administrator; false: otherwise.
Access:  public


[ Top ]
current_user_is_anonymous  [line 174]

true: current_user_is_anonymous( )

Returns true if the currently user is the anonymous user


API Tags:
Return:  user anonymous; false: otherwise.
Access:  public


[ Top ]
current_user_is_protected  [line 164]

true: current_user_is_protected( )

Returns true if the currently logged in user protected, false otherwise


API Tags:
Return:  user protected; false: otherwise.
Access:  public


[ Top ]
current_user_set_default_project  [line 106]

void current_user_set_default_project( project_id $p_project_id  )

Return the specified field of the currently logged in user

Parameters:
project_id   $p_project_id:  The new default project id.

API Tags:
Access:  public


[ Top ]
current_user_set_pref  [line 96]

void current_user_set_pref( pref_name $p_pref_name, pref_value $p_pref_value  )

Sets the specified preference for the current logged in user.

Parameters:
pref_name   $p_pref_name:  The name of the preference as in the preferences table.
pref_value   $p_pref_value:  The preference new value.

API Tags:
Access:  public


[ Top ]


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