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

Procedural File: mc_issue_api.php

Source Location: /api/soap/mc_issue_api.php

Page Details
Includes

Functions
mci_issue_get_attachments  [line 194]

Array mci_issue_get_attachments( integer $p_issue_id  )

Get the attachments of an issue.

Parameters:
integer   $p_issue_id:  The id of the issue to retrieve the attachments for

API Tags:
Return:  that represents an AttachmentData structure


[ Top ]
mci_issue_get_custom_fields  [line 156]

null mci_issue_get_custom_fields( $p_issue_id $p_issue_id  )

Get the custom field values associated with the specified issue id.

Parameters:
$p_issue_id   $p_issue_id:  Issue id to get the custom field values for.

API Tags:
Return:  if no custom field defined for the project that contains the issue, or if no custom fields are accessible to the current user.


[ Top ]
mci_issue_get_notes  [line 258]

Array mci_issue_get_notes( integer $p_issue_id  )

Get all visible notes for a specific issue

Parameters:
integer   $p_issue_id:  The id of the issue to retrieve the notes for

API Tags:
Return:  that represents an IssueNoteData structure


[ Top ]
mci_issue_get_relationships  [line 218]

Array mci_issue_get_relationships( integer $p_issue_id, $p_user_id  )

Get the relationships of an issue.

Parameters:
integer   $p_issue_id:  The id of the issue to retrieve the relationships for
   $p_user_id: 

API Tags:
Return:  that represents an RelationShipData structure


[ Top ]
mci_issue_set_custom_fields  [line 117]

void mci_issue_set_custom_fields( $p_issue_id $p_issue_id, $p_custom_fields &$p_custom_fields  )

Sets the supplied array of custom field values to the specified issue id.

Parameters:
$p_issue_id   $p_issue_id:  Issue id to apply custom field values to.
$p_custom_fields   &$p_custom_fields:  The array of custom field values as described in the webservice complex types.


[ Top ]
mc_issue_add  [line 408]

integer mc_issue_add( string $p_username, string $p_password, Array $p_issue  )

Add an issue to the database.

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

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


[ Top ]
mc_issue_checkin  [line 1001]

boolean mc_issue_checkin( string $p_username, string $p_password, integer $p_issue_id, string $p_comment, boolean $p_fixed  )

Log a checkin event on the issue

Parameters:
string   $p_username:  The name of the user trying to access the issue.
string   $p_password:  The password of the user.
integer   $p_issue_id:  The id of the issue to log a checkin.
string   $p_comment:  The comment to add
boolean   $p_fixed:  True if the issue is to be set to fixed

API Tags:
Return:  true success, false otherwise.


[ Top ]
mc_issue_delete  [line 747]

boolean mc_issue_delete( string $p_username, string $p_password, integer $p_issue_id  )

Delete the specified issue.

Parameters:
string   $p_username:  The name of the user trying to delete the issue.
string   $p_password:  The password of the user.
integer   $p_issue_id:  The id of the issue to delete.

API Tags:
Return:  True if the issue has been deleted successfully, false otherwise.


[ Top ]
mc_issue_exists  [line 19]

boolean mc_issue_exists( string $p_username, string $p_password, integer $p_issue_id  )

Check if an issue with the given id exists.

Parameters:
string   $p_username:  The name of the user trying to access the issue.
string   $p_password:  The password of the user.
integer   $p_issue_id:  The id of the issue to check.

API Tags:
Return:  true if there is an issue with the given id, false otherwise.


[ Top ]
mc_issue_get  [line 47]

Array mc_issue_get( string $p_username, string $p_password, integer $p_issue_id  )

Get all details about an issue.

Parameters:
string   $p_username:  The name of the user trying to access the issue.
string   $p_password:  The password of the user.
integer   $p_issue_id:  The id of the issue to retrieve.

API Tags:
Return:  that represents an IssueData structure


[ Top ]
mc_issue_get_biggest_id  [line 287]

integer mc_issue_get_biggest_id( string $p_username, string $p_password, int $p_project_id  )

Get the biggest issue id currently used.

Parameters:
string   $p_username:  The name of the user trying to retrieve the information
string   $p_password:  The password of the user.
int   $p_project_id:  -1 default project, 0 for all projects, otherwise project id.

API Tags:
Return:  The biggest used issue id.


[ Top ]
mc_issue_get_id_from_summary  [line 367]

integer mc_issue_get_id_from_summary( string $p_username, string $p_password, string $p_summary  )

Get the id of an issue via the issue's summary.

Parameters:
string   $p_username:  The name of the user trying to delete the issue.
string   $p_password:  The password of the user.
string   $p_summary:  The summary of the issue to retrieve.

API Tags:
Return:  The id of the issue with the given summary, 0 if there is no such issue.


[ Top ]
mc_issue_note_add  [line 774]

integer mc_issue_note_add( string $p_username, string $p_password, integer $p_issue_id, IssueNoteData $p_note  )

Add a note to an existing issue.

Parameters:
string   $p_username:  The name of the user trying to add a note to an issue.
string   $p_password:  The password of the user.
integer   $p_issue_id:  The id of the issue to add the note to.
IssueNoteData   $p_note:  The note to add.

API Tags:
Return:  The id of the added note.


[ Top ]
mc_issue_note_delete  [line 821]

true: mc_issue_note_delete( string $p_username, string $p_password, integer $p_issue_note_id  )

Delete a note given its id.

Parameters:
string   $p_username:  The name of the user trying to add a note to an issue.
string   $p_password:  The password of the user.
integer   $p_issue_note_id:  The id of the note to be deleted.

API Tags:
Return:  success, false: failure


[ Top ]
mc_issue_relationship_add  [line 853]

integer mc_issue_relationship_add( string $p_username, string $p_password, integer $p_issue_id, RelationshipData $p_relationship  )

Submit a new relationship.

Parameters:
string   $p_username:  The name of the user trying to add a note to an issue.
string   $p_password:  The password of the user.
integer   $p_issue_id:  The id of the issue of the source issue.
RelationshipData   $p_relationship:  The relationship to add.

API Tags:
Return:  The id of the added relationship.


[ Top ]
mc_issue_relationship_delete  [line 927]

true: mc_issue_relationship_delete( string $p_username, string $p_password, integer $p_issue_id, integer $p_relationship_id  )

Delete the relationship with the specified target id.

Parameters:
string   $p_username:  The name of the user trying to add a note to an issue.
string   $p_password:  The password of the user.
integer   $p_issue_id:  The id of the source issue for the relationship
integer   $p_relationship_id:  The id of relationship to delete.

API Tags:
Return:  success, false: failure


[ Top ]
mc_issue_update  [line 582]

integer mc_issue_update( string $p_username, string $p_password, $p_issue_id, Array $p_issue  )

Update Issue in database

Created By KGB

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

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


[ Top ]


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