Arbit - project tracking, tracked with Arbit

API documentation :: Docs For Class arbitCouchDbTrackerCommentFacade

LICENSE

INSTALL

Packages:

Interfaces:

Facade
- arbitTrackerCommentFacade
- arbitTrackerIssueFacade
- arbitTrackerIssueStatisticsFacade

Classes:

Chart
- arbitTrackerActivityChartModel
- arbitTrackerStatesChartModel
- arbitTrackerTypeChartModel

CouchDbBackend
- arbitBackendCouchDbSourceAnnotationView
- arbitBackendCouchDbTrackerCommentView
- arbitBackendCouchDbTrackerIssueView
- arbitBackendCouchDbTrackerStatisticsView

View
- arbitModuleTemplateViewHandler
- arbitModuleTrackerEmailHandler
- arbitModuleTrackerXHtmlHandler
- arbitTrackerAttachementViewStruct
- arbitTrackerChangedStateViewStruct
- arbitTrackerCommentedViewStruct
- arbitTrackerCommentViewModel
- arbitTrackerIssueCreateModel
- arbitTrackerIssueEditModel
- arbitTrackerIssueListViewModel
- arbitTrackerIssueQuickResolveModel
- arbitTrackerIssueViewModel
- arbitTrackerNewIssueViewStruct
- arbitTrackerOverviewViewModel
- arbitTrackerPermissionDeniedViewModel
- arbitTrackerReportViewModel
- arbitTrackerRoadmapViewModel
- arbitTrackerSearchViewModel

Facade
- arbitCouchDbTrackerCommentFacade
- arbitCouchDbTrackerIssueFacade
- arbitCouchDbTrackerIssueStatisticsFacade

Model
- arbitModuleModelTrackerComment
- arbitModuleModelTrackerIssue
- arbitModuleModelTrackerIssueIdGenerator
- arbitModuleModelTrackerIssueStatistics

IniBackend
- arbitTrackerBackendIniModuleConfiguration

Tracker::Facade::arbitCouchDbTrackerCommentFacade

Class arbitCouchDbTrackerCommentFacade

Comment facade defining all methods required to access comment related data in the backend.

Implements interfaces:

arbitTrackerCommentFacade

arbitCouchDbFacadeBase
   |
   --arbitCouchDbTrackerCommentFacade

Author(s):

Version:	$Revision: 1604 $
License:	GPL

Inherited Member Variables

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

Method Summary

public static array	`getLastCommented( [ $count = 5] )` Get last commented issues Get the issues with the most recent comments.
public mixed	`createComment( )` Create a new comment Create a new comment.
public array	`getCommentData( $comment )` Get comment data
public array	`getCommentsForIssue( $issue )` Get comments for issue Get a list of all comments for a issue. creation, but currently not returned in some kind of tree.
public void	`updateCommentData( $id , $data )` Update stored information for the given comment 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

getLastCommented

static array getLastCommented( [int $count = 5] )

Get last commented issues Get the issues with the most recent comments.

Parameters:

Name	Type	Description
`$count`	int

Implementation of:

Method	Description
`arbitTrackerCommentFacade::getLastCommented()`	Get last commented issues Get the issues with the most recent comments.

createComment

mixed createComment( )

Create a new comment Create a new comment.

Implementation of:

Method	Description
`arbitTrackerCommentFacade::createComment()`	Create a new comment Create a new comment.

getCommentData

array getCommentData( mixed $comment )

Get comment data

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

id
issue
author
comment
revisions

Parameters:

Name	Type	Description
`$comment`	mixed

Implementation of:

Method	Description
`arbitTrackerCommentFacade::getCommentData()`	Get comment data

getCommentsForIssue

array getCommentsForIssue( mixed $issue )

Get comments for issue Get a list of all comments for a issue. creation, but currently not returned in some kind of tree.

Get comments for issue Get a list of all comments for a issue. The comments are sorted by their creation, but currently not returned in some kind of tree.

Parameters:

Name	Type	Description
`$issue`	mixed

Implementation of:

Method	Description
`arbitTrackerCommentFacade::getCommentsForIssue()`	Get comments for issue Get a list of all comments for a issue. creation, but currently not returned in some kind of tree.

updateCommentData

void updateCommentData( mixed $id , array $data )

Update stored information for the given comment 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`	mixed
`$data`	array

Implementation of:

Method	Description
`arbitTrackerCommentFacade::updateCommentData()`	Update stored information for the given comment 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:01:42 +0200 by phpDocumentor 1.4.3