Arbit - project tracking, tracked with Arbit

public void	`attachFile( $id , $fileName , $mimeType )` Attach file to issue Attach a file to the issue specified by its ID. given as a third parameter and should also be stored.
public mixed	`createIssue( $id )` Create a new issue Create a new issue with the given ID. if there already is a issue with the given ID.
public array	`fetchIssuesPerMilestone( )` Fetch issue per milestone Returns an array with the milestones as keys and an array of issues for that milestone.
public array	`getAffectedUsers( $id )` Get affected users Get a list of users which relate to the current issue, either by having commented to, created is, or are assigned to the issue.
public array	`getAllIssues( )` Get issue list Get an array with all issues currently available in the bug tracker.
public string	`getFileContents( $id , $fileName )` Get file contents Return the contents of the file specified by its storage file name.
public array	`getIssueData( $issue )` Get issue data
public mixed	`getIssueId( $number )` Get issue by its number Return the issue ID for the issue with the given number.
public int	`getLastIssueNumber( )` Return the last issue number Returns the highest issue currently in the database.
public void	`updateIssueData( $id , $data )` Update stored information for the given issue The array with the information to update may any number of the common keys, and only the given keys will be updated in the storage backend.

Methods

attachFile

void attachFile( mixed $id , string $fileName , string $mimeType )

Attach file to issue Attach a file to the issue specified by its ID. given as a third parameter and should also be stored.

Attach file to issue Attach a file to the issue specified by its ID. The files mime type is given as a third parameter and should also be stored.

Parameters:

Name	Type	Description
`$id`	mixed
`$fileName`	string
`$mimeType`	string

createIssue

mixed createIssue( int $id )

Create a new issue Create a new issue with the given ID. if there already is a issue with the given ID.

Create a new issue Create a new issue with the given ID. An exception will be thrown if there already is a issue with the given ID.

Parameters:

Name	Type	Description
`$id`	int

fetchIssuesPerMilestone

array fetchIssuesPerMilestone( )

Fetch issue per milestone Returns an array with the milestones as keys and an array of issues for that milestone.

getAffectedUsers

array getAffectedUsers( mixed $id )

Get affected users Get a list of users which relate to the current issue, either by having commented to, created is, or are assigned to the issue.

Parameters:

Name	Type	Description
`$id`	mixed

getAllIssues

array getAllIssues( )

Get issue list Get an array with all issues currently available in the bug tracker.

getFileContents

string getFileContents( mixed $id , string $fileName )

Get file contents Return the contents of the file specified by its storage file name.

Parameters:

Name	Type	Description
`$id`	mixed
`$fileName`	string

getIssueData

array getIssueData( mixed $issue )

Get issue data

Get issue data Get the data of a given issue, the issue data contains of the following fields:

id
issue
issueType
title
author
edited
ip
text
state
priority
resolution
versions
scheduled
components
assigned
revisions
attachments

Parameters:

Name	Type	Description
`$issue`	mixed

getIssueId

mixed getIssueId( int $number )

Get issue by its number Return the issue ID for the issue with the given number.

Get issue by its number Return the issue ID for the issue with the given number. This might be done by a query to the backend, or an ID recalculation depending, if its is easy to calculate.

Parameters:

Name	Type	Description
`$number`	int

getLastIssueNumber

int getLastIssueNumber( )

Return the last issue number Returns the highest issue currently in the database.

updateIssueData

void updateIssueData( int $id , array $data )

Update stored information for the given issue The array with the information to update may any number of the common keys, and only the given keys will be updated in the storage backend.

Parameters:

Name	Type	Description
`$id`	int
`$data`	array

Documentation generated on Mon, 05 Apr 2010 14:02:00 +0200 by phpDocumentor 1.4.3