[ Index ]

PHP Cross Reference of MantisBT

title

Body

[close]

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

(no description)

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

Defines 22 functions

  mc_issue_exists()
  mc_issue_get()
  mci_get_category()
  mci_issue_get_due_date()
  mci_issue_set_custom_fields()
  mci_issue_get_custom_fields()
  mci_issue_get_attachments()
  mci_issue_get_relationships()
  mci_issue_get_notes()
  mci_issue_set_monitors()
  mc_issue_get_biggest_id()
  mc_issue_get_id_from_summary()
  mc_issue_add()
  mc_issue_update()
  mc_issue_delete()
  mc_issue_note_add()
  mc_issue_note_delete()
  mc_issue_note_update()
  mc_issue_relationship_add()
  mc_issue_relationship_delete()
  mci_iso8601_to_timestamp()
  mci_issue_data_as_array()

Functions
Functions that are not part of a class:

mc_issue_exists( $p_username, $p_password, $p_issue_id )   X-Ref
Check if an issue with the given id exists.

param: string $p_username  The name of the user trying to access the issue.
param: string $p_password  The password of the user.
param: integer $p_issue_id  The id of the issue to check.
return: boolean  true if there is an issue with the given id, false otherwise.

mc_issue_get( $p_username, $p_password, $p_issue_id )   X-Ref
Get all details about an issue.

param: string $p_username  The name of the user trying to access the issue.
param: string $p_password  The password of the user.
param: integer $p_issue_id  The id of the issue to retrieve.
return: Array that represents an IssueData structure

mci_get_category( $p_category_id )   X-Ref
Returns the category name, possibly null if no category is assigned

param: int $p_category_id
return: string

mci_issue_get_due_date( $p_bug )   X-Ref

param: BugData $bug
return: soapval the value to be encoded as the due date

mci_issue_set_custom_fields( $p_issue_id, &$p_custom_fields, $p_log_insert )   X-Ref
Sets the supplied array of custom field values to the specified issue id.

param: $p_issue_id   Issue id to apply custom field values to.
param: $p_custom_fields  The array of custom field values as described in the webservice complex types.
param: boolean $p_log_insert create history logs for new values

mci_issue_get_custom_fields( $p_issue_id )   X-Ref
Get the custom field values associated with the specified issue id.

param: $p_issue_id   Issue id to get the custom field values for.
return: null if no custom field defined for the project that contains the issue, or if no custom

mci_issue_get_attachments( $p_issue_id )   X-Ref
Get the attachments of an issue.

param: integer $p_issue_id  The id of the issue to retrieve the attachments for
return: Array that represents an AttachmentData structure

mci_issue_get_relationships( $p_issue_id, $p_user_id )   X-Ref
Get the relationships of an issue.

param: integer $p_issue_id  The id of the issue to retrieve the relationships for
return: Array that represents an RelationShipData structure

mci_issue_get_notes( $p_issue_id )   X-Ref
Get all visible notes for a specific issue

param: integer $p_issue_id  The id of the issue to retrieve the notes for
return: Array that represents an IssueNoteData structure

mci_issue_set_monitors( $p_issue_id , $p_user_id, $p_monitors )   X-Ref
Sets the monitors of the specified issue

<p>This functions performs access level checks and only performs operations which would
modify the existing monitors list.</p>

param: int $p_issue_id the issue id to set the monitors for
param: int $p_user_id the user which requests the monitor change
param: array $p_monitors An array of arrays with the <em>id</em> field set to the id

mc_issue_get_biggest_id( $p_username, $p_password, $p_project_id )   X-Ref
Get the biggest issue id currently used.

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

mc_issue_get_id_from_summary( $p_username, $p_password, $p_summary )   X-Ref
Get the id of an issue via the issue's summary.

param: string $p_username  The name of the user trying to delete the issue.
param: string $p_password  The password of the user.
param: string $p_summary  The summary of the issue to retrieve.
return: integer  The id of the issue with the given summary, 0 if there is no such issue.

mc_issue_add( $p_username, $p_password, $p_issue )   X-Ref
Add an issue to the database.

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_issue  A IssueData structure containing information about the new issue.
return: integer  The id of the created issue.

mc_issue_update( $p_username, $p_password, $p_issue_id, $p_issue )   X-Ref
Update Issue in database

Created By KGB
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_issue A IssueData structure containing information about the new issue.
return: integer The id of the created issue.

mc_issue_delete( $p_username, $p_password, $p_issue_id )   X-Ref
Delete the specified issue.

param: string $p_username  The name of the user trying to delete the issue.
param: string $p_password  The password of the user.
param: integer $p_issue_id  The id of the issue to delete.
return: boolean  True if the issue has been deleted successfully, false otherwise.

mc_issue_note_add( $p_username, $p_password, $p_issue_id, $p_note )   X-Ref
Add a note to an existing issue.

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

mc_issue_note_delete( $p_username, $p_password, $p_issue_note_id )   X-Ref
Delete a note given its id.

param: string $p_username  The name of the user trying to add a note to an issue.
param: string $p_password  The password of the user.
param: integer $p_issue_note_id  The id of the note to be deleted.
return: true: success, false: failure

mc_issue_note_update( $p_username, $p_password, $p_note )   X-Ref
Update a note

param: string $p_username  The name of the user trying to add a note to an issue.
param: IssueNoteData $p_note  The note to update.
return: true on success, false on failure

mc_issue_relationship_add( $p_username, $p_password, $p_issue_id, $p_relationship )   X-Ref
Submit a new relationship.

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

mc_issue_relationship_delete( $p_username, $p_password, $p_issue_id, $p_relationship_id )   X-Ref
Delete the relationship with the specified target id.

param: string $p_username  The name of the user trying to add a note to an issue.
param: string $p_password  The password of the user.
param: integer $p_issue_id  The id of the source issue for the relationship
param: integer $p_relationship_id  The id of relationship to delete.
return: true: success, false: failure

mci_iso8601_to_timestamp( $p_date )   X-Ref
Returns the date in iso8601 format, with proper timezone offset applied

param: string $p_date the date in iso8601 format
return: int the timestamp

mci_issue_data_as_array( $p_issue_data, $p_user_id, $p_lang )   X-Ref
Returns an array for SOAP encoding from a BugData object

param: BugData $p_issue_data
param: int $p_user_id
param: string $p_lang
return: array The issue as an array



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