Arbit - project tracking

Arbit - project tracking

API documentation :: Docs For Class arbitTrackerCommentFacade

Packages:

Interfaces:

Classes:

Tracker::Facade::arbitTrackerCommentFacade

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

Interface arbitTrackerCommentFacade

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

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

Author(s):
Version:   $Revision: 1236 $
License:   GPL

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.

Methods

getLastCommented

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

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

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

Parameters:
Name Type Description
$count int

createComment

mixed createComment( )

Create a new comment Create a new comment.

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

Parameters:
Name Type Description
$comment mixed

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

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.

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
Documentation generated on Mon, 05 Apr 2010 14:01:42 +0200 by phpDocumentor 1.4.3

Arbit - project tracking, licensed under GPL 3