phpDocumentor MantisBT
[ class tree: MantisBT ] [ index: MantisBT ] [ all elements ]

Procedural File: mc_project_api.php

Source Location: /api/soap/mc_project_api.php

Page Details
Functions
mci_project_as_array_by_id  [line 594]

Array mci_project_as_array_by_id( integer $p_project_id  )

Get a project definition.

Parameters:
integer   $p_project_id:  The id of the project to retrieve.

API Tags:
Return:  an Array containing the id and the name of the project.


[ Top ]
mc_projects_get_user_accessible  [line 85]

Array mc_projects_get_user_accessible( string $p_username, string $p_password  )

Get all projects accessible by the given user.

Parameters:
string   $p_username:  The name of the user trying to access the project list.
string   $p_password:  The password of the user.

API Tags:
Return:  suitable to be converted into a ProjectDataArray


[ Top ]
mc_project_add  [line 610]

integer mc_project_add( string $p_username, string $p_password, Array $p_project  )

Add a new project.

Parameters:
string   $p_username:  The name of the user trying to access the versions.
string   $p_password:  The password of the user.
Array   $p_project:  A new ProjectData structure

API Tags:
Return:  the new project's project_id


[ Top ]
mc_project_delete  [line 682]

bool mc_project_delete( string $p_username, string $p_password, integer $p_project_id  )

Delete a project.

Parameters:
string   $p_username:  The name of the user trying to access the versions.
string   $p_password:  The password of the user.
integer   $p_project_id:  A project's id

API Tags:
Return:  returns true or false depending on the success of the delete action


[ Top ]
mc_project_get_attachments  [line 504]

Array mc_project_get_attachments( string $p_username, string $p_password, integer $p_project_id  )

Get the attachments that belong to the specified project.

Parameters:
string   $p_username:  The name of the user trying to access the versions.
string   $p_password:  The password of the user.
integer   $p_project_id:  The id of the project to retrieve the attachments for.

API Tags:
Return:  representing a ProjectAttachmentDataArray structure.


[ Top ]
mc_project_get_categories  [line 124]

Array mc_project_get_categories( string $p_username, string $p_password, integer $p_project_id  )

Get all categories of a project.

Parameters:
string   $p_username:  The name of the user trying to access the categories.
string   $p_password:  The password of the user.
integer   $p_project_id:  The id of the project to retrieve the categories for.

API Tags:
Return:  of categorie names


[ Top ]
mc_project_get_custom_fields  [line 446]

Array mc_project_get_custom_fields( string $p_username, string $p_password, integer $p_project_id  )

Get the custom fields that belong to the specified project.

Parameters:
string   $p_username:  The name of the user trying to access the versions.
string   $p_password:  The password of the user.
integer   $p_project_id:  The id of the project to retrieve the custom fields for.

API Tags:
Return:  representing a CustomFieldDefinitionDataArray structure.


[ Top ]
mc_project_get_issues  [line 9]

void mc_project_get_issues( $p_username, $p_password, $p_project_id, $p_page_number, $p_per_page  )
Parameters:
   $p_username: 
   $p_password: 
   $p_project_id: 
   $p_page_number: 
   $p_per_page: 


[ Top ]
mc_project_get_issue_headers  [line 699]

void mc_project_get_issue_headers( $p_username, $p_password, $p_project_id, $p_page_number, $p_per_page  )
Parameters:
   $p_username: 
   $p_password: 
   $p_project_id: 
   $p_page_number: 
   $p_per_page: 


[ Top ]
mc_project_get_released_versions  [line 193]

Array mc_project_get_released_versions( string $p_username, string $p_password, integer $p_project_id  )

Get all released versions of a project.

Parameters:
string   $p_username:  The name of the user trying to access the versions.
string   $p_password:  The password of the user.
integer   $p_project_id:  The id of the project to retrieve the versions for.

API Tags:
Return:  representing a ProjectVersionDataArray structure.


[ Top ]
mc_project_get_unreleased_versions  [line 232]

Array mc_project_get_unreleased_versions( string $p_username, string $p_password, integer $p_project_id  )

Get all unreleased (a.k.a. future) versions of a project.

Parameters:
string   $p_username:  The name of the user trying to access the versions.
string   $p_password:  The password of the user.
integer   $p_project_id:  The id of the project to retrieve the versions for.

API Tags:
Return:  representing a ProjectVersionDataArray structure.


[ Top ]
mc_project_get_users  [line 758]

Array mc_project_get_users( string $p_username, string $p_password, integer $p_project_id, integer $p_access  )

Get appropriate users assigned to a project by access level.

Parameters:
string   $p_username:  The name of the user trying to access the versions.
string   $p_password:  The password of the user.
integer   $p_project_id:  The id of the project to retrieve the users for.
integer   $p_access:  Minimum access level.

API Tags:
Return:  representing a ProjectAttachmentDataArray structure.


[ Top ]
mc_project_get_versions  [line 155]

Array mc_project_get_versions( string $p_username, string $p_password, integer $p_project_id  )

Get all versions of a project.

Parameters:
string   $p_username:  The name of the user trying to access the versions.
string   $p_password:  The password of the user.
integer   $p_project_id:  The id of the project to retrieve the versions for.

API Tags:
Return:  representing a ProjectVersionDataArray structure.


[ Top ]
mc_project_version_add  [line 271]

integer mc_project_version_add( string $p_username, string $p_password, Array $p_version  )

Submit the specified version details.

Parameters:
string   $p_username:  The name of the user trying to add the issue.
string   $p_password:  The password of the user.
Array   $p_version:  A ProjectVersionData structure containing information about the new verison.

API Tags:
Return:  The id of the created version.


[ Top ]
mc_project_version_delete  [line 410]

bool mc_project_version_delete( string $p_username, string $p_password, integer $p_version_id  )

Delete a version.

Parameters:
string   $p_username:  The name of the user trying to delete the version.
string   $p_password:  The password of the user.
integer   $p_version_id:  A version's id

API Tags:
Return:  returns true or false depending on the success of the delete action


[ Top ]
mc_project_version_update  [line 338]

bool mc_project_version_update( string $p_username, string $p_password, integer $p_version_id, Array $p_version  )

Submit the specified version details.

Parameters:
string   $p_username:  The name of the user trying to update the issue.
string   $p_password:  The password of the user.
integer   $p_version_id:  A version's id
Array   $p_version:  A ProjectVersionData structure containing information about the new verison.

API Tags:
Return:  returns true or false depending on the success of the update action


[ Top ]


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