Arbit - project tracking

Arbit - project tracking

API documentation :: Docs For Class arbitCouchDbTrackerIssueFacade

Packages:

Interfaces:

Classes:

Tracker::Facade::arbitCouchDbTrackerIssueFacade

[ Index ] [ Tracker classes ] [ Tracker elements ] [ All elements ] [ Errors ]

Class arbitCouchDbTrackerIssueFacade

Issue facade defining all methods required to access issue related data in the backend.

Issue facade defining all methods required to access issue related data in the backend.

Implements interfaces:

arbitCouchDbFacadeBase
   |
   --arbitCouchDbTrackerIssueFacade
Author(s):
Version:   $Revision: 1595 $
License:   GPL

Inherited Member Variables

From arbitCouchDbFacadeBase
protected arbitCouchDbFacadeBase::$connected
protected arbitCouchDbFacadeBase::$manager

Method Summary

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.

Inherited Methods

From arbitCouchDbFacadeBase
public void arbitCouchDbFacadeBase::__construct()
Constructor The constructor ensures the correct configuration for the conenction by connecting on the first request to on of the facde classes.

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
Implementation of:
Method Description
arbitTrackerIssueFacade::attachFile() Attach file to issue Attach a file to the issue specified by its ID. given as a third parameter and should also be stored.

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
Implementation of:
Method Description
arbitTrackerIssueFacade::createIssue() Create a new issue Create a new issue with the given ID. if there already is a issue with the given ID.

fetchIssuesPerMilestone

array fetchIssuesPerMilestone( )

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

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

Implementation of:
Method Description
arbitTrackerIssueFacade::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.

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
Implementation of:
Method Description
arbitTrackerIssueFacade::getAffectedUsers() 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.

getAllIssues

array getAllIssues( )

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

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

Implementation of:
Method Description
arbitTrackerIssueFacade::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.

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

Parameters:
Name Type Description
$id mixed
$fileName string
Implementation of:
Method Description
arbitTrackerIssueFacade::getFileContents() Get file contents Return the contents of the file specified by its storage file name.

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
Implementation of:
Method Description
arbitTrackerIssueFacade::getIssueData() Get issue data

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
Implementation of:
Method Description
arbitTrackerIssueFacade::getIssueId() Get issue by its number Return the issue ID for the issue with the given number.

getLastIssueNumber

int getLastIssueNumber( )

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

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

Implementation of:
Method Description
arbitTrackerIssueFacade::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.

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
Implementation of:
Method Description
arbitTrackerIssueFacade::updateIssueData() 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.
Documentation generated on Mon, 05 Apr 2010 14:02:00 +0200 by phpDocumentor 1.4.3

Arbit - project tracking, licensed under GPL 3