[ Index ]

PHP Cross Reference of MantisBT

title

Body

[close]

/api/soap/ -> mc_project_api.php (summary)

(no description)

File Size: 958 lines (34 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 22 functions

  mc_project_get_issues()
  mc_projects_get_user_accessible()
  mc_project_get_categories()
  mc_project_add_category()
  mc_project_delete_category()
  mc_project_rename_category_by_name()
  mc_project_get_versions()
  mc_project_get_released_versions()
  mc_project_get_unreleased_versions()
  mc_project_version_add()
  mc_project_version_update()
  mc_project_version_delete()
  mc_project_get_custom_fields()
  mc_project_get_attachments()
  mc_project_get_all_subprojects()
  mci_project_as_array_by_id()
  mc_project_get_id_from_name()
  mc_project_add()
  mc_project_update()
  mc_project_delete()
  mc_project_get_issue_headers()
  mc_project_get_users()

Functions
Functions that are not part of a class:

mc_project_get_issues( $p_username, $p_password, $p_project_id, $p_page_number, $p_per_page )   X-Ref
No description

mc_projects_get_user_accessible( $p_username, $p_password )   X-Ref
Get all projects accessible by the given user.

param: string $p_username  The name of the user trying to access the project list.
param: string $p_password  The password of the user.
return: Array  suitable to be converted into a ProjectDataArray

mc_project_get_categories( $p_username, $p_password, $p_project_id )   X-Ref
Get all categories of a project.

param: string $p_username  The name of the user trying to access the categories.
param: string $p_password  The password of the user.
param: integer $p_project_id  The id of the project to retrieve the categories for.
return: Array  of categorie names

mc_project_add_category($p_username, $p_password, $p_project_id, $p_category_name )   X-Ref
Add a new category to a project

param: string $p_username  The name of the user trying to access the categories.
param: string $p_password  The password of the user.
param: integer $p_project_id  The id of the project to retrieve the categories for.
param: string $p_category_name The name of the new category to add
return: integer id of the new category

mc_project_delete_category($p_username, $p_password, $p_project_id, $p_category_name)   X-Ref
Delete a category of a project

param: string $p_username  The name of the user trying to access the categories.
param: string $p_password  The password of the user.
param: integer $p_project_id  The id of the project to retrieve the categories for.
param: string $p_category_name The name of the category to delete
return: bool returns true or false depending on the success of the delete action

mc_project_rename_category_by_name( $p_username, $p_password, $p_project_id, $p_category_name, $p_category_name_new, $p_assigned_to )   X-Ref
Update a category of a project

param: string $p_username  The name of the user trying to access the categories.
param: string $p_password  The password of the user.
param: integer $p_project_id  The id of the project to retrieve the categories for.
param: string $p_category_name The name of the category to rename
param: string $p_category_name_new The new name of the category to rename
param: int $p_assigned_to User ID that category is assigned to
return: bool returns true or false depending on the success of the update action

mc_project_get_versions( $p_username, $p_password, $p_project_id )   X-Ref
Get all versions of a project.

param: string $p_username  The name of the user trying to access the versions.
param: string $p_password  The password of the user.
param: integer $p_project_id  The id of the project to retrieve the versions for.
return: Array  representing a ProjectVersionDataArray structure.

mc_project_get_released_versions( $p_username, $p_password, $p_project_id )   X-Ref
Get all released versions of a project.

param: string $p_username  The name of the user trying to access the versions.
param: string $p_password  The password of the user.
param: integer $p_project_id  The id of the project to retrieve the versions for.
return: Array  representing a ProjectVersionDataArray structure.

mc_project_get_unreleased_versions( $p_username, $p_password, $p_project_id )   X-Ref
Get all unreleased (a.k.a. future) versions of a project.

param: string $p_username  The name of the user trying to access the versions.
param: string $p_password  The password of the user.
param: integer $p_project_id  The id of the project to retrieve the versions for.
return: Array  representing a ProjectVersionDataArray structure.

mc_project_version_add( $p_username, $p_password, $p_version )   X-Ref
Submit the specified version details.

param: string $p_username  The name of the user trying to add the issue.
param: string $p_password  The password of the user.
param: Array $p_version  A ProjectVersionData structure containing information about the new verison.
return: integer  The id of the created version.

mc_project_version_update( $p_username, $p_password, $p_version_id, $p_version )   X-Ref
Submit the specified version details.

param: string $p_username  The name of the user trying to update the issue.
param: string $p_password  The password of the user.
param: integer $p_version_id A version's id
param: Array $p_version  A ProjectVersionData structure containing information about the new verison.
return: bool returns true or false depending on the success of the update action

mc_project_version_delete( $p_username, $p_password, $p_version_id )   X-Ref
Delete a version.

param: string $p_username  The name of the user trying to delete the version.
param: string $p_password  The password of the user.
param: integer $p_version_id A version's id
return: bool returns true or false depending on the success of the delete action

mc_project_get_custom_fields( $p_username, $p_password, $p_project_id )   X-Ref
Get the custom fields that belong to the specified project.

param: string $p_username  The name of the user trying to access the versions.
param: string $p_password  The password of the user.
param: integer $p_project_id  The id of the project to retrieve the custom fields for.
return: Array  representing a CustomFieldDefinitionDataArray structure.

mc_project_get_attachments( $p_username, $p_password, $p_project_id )   X-Ref
Get the attachments that belong to the specified project.

param: string $p_username  The name of the user trying to access the versions.
param: string $p_password  The password of the user.
param: integer $p_project_id  The id of the project to retrieve the attachments for.
return: Array  representing a ProjectAttachmentDataArray structure.

mc_project_get_all_subprojects( $p_username, $p_password, $p_project_id )   X-Ref
No description

mci_project_as_array_by_id( $p_project_id )   X-Ref
Get a project definition.

param: integer $p_project_id  The id of the project to retrieve.
return: Array an Array containing the id and the name of the project.

mc_project_get_id_from_name( $p_username, $p_password, $p_project_name )   X-Ref
Get the id of a project via the project's name.

param: string $p_username  The name of the user trying to access the versions.
param: string $p_password  The password of the user.
param: string $p_project_name  The name of the project to retrieve.
return: integer  The id of the project with the given name, -1 if there is no such project.

mc_project_add( $p_username, $p_password, $p_project )   X-Ref
Add a new project.

param: string $p_username  The name of the user trying to access the versions.
param: string $p_password  The password of the user.
param: Array $p_project A new ProjectData structure
return: integer the new project's project_id

mc_project_update( $p_username, $p_password, $p_project_id, $p_project )   X-Ref
Update a project

param: string $p_username  The name of the user
param: string $p_password  The password of the user
param: integer $p_project_id A project's id
param: Array $p_project A new ProjectData structure
return: bool returns true or false depending on the success of the update action

mc_project_delete( $p_username, $p_password, $p_project_id )   X-Ref
Delete a project.

param: string $p_username  The name of the user trying to access the versions.
param: string $p_password  The password of the user.
param: integer $p_project_id A project's id
return: bool returns true or false depending on the success of the delete action

mc_project_get_issue_headers( $p_username, $p_password, $p_project_id, $p_page_number, $p_per_page )   X-Ref
No description

mc_project_get_users( $p_username, $p_password, $p_project_id, $p_access )   X-Ref
Get appropriate users assigned to a project by access level.

param: string $p_username  The name of the user trying to access the versions.
param: string $p_password  The password of the user.
param: integer $p_project_id  The id of the project to retrieve the users for.
param: integer $p_access Minimum access level.
return: Array  representing a ProjectAttachmentDataArray structure.



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