Arbit - project tracking, tracked with Arbit

API documentation :: Docs For Class arbitCouchDbSourceAnnotationFacade

LICENSE

INSTALL

Packages:

Interfaces:

Facade
- arbitSourceAnnotationFacade

Classes:

Model
- arbitModuleModelSourceAnnotation
- arbitModuleSourceVcsModel

Facade
- arbitCouchDbSourceAnnotationFacade

View
- arbitModuleSourceTextHandler
- arbitModuleSourceXHtmlHandler
- arbitSourceAnnotationsViewModel
- arbitSourceCheckoutViewModel
- arbitSourceDiffViewModel
- arbitSourceDirectoryViewModel
- arbitSourceFileViewModel
- arbitSourceHistoryModel
- arbitSourceInitializedViewStruct
- arbitSourceUpdatedViewStruct
- arbitSourceViewModel

IniBackend
- arbitSourceBackendIniModuleConfiguration

Source::Facade::arbitCouchDbSourceAnnotationFacade

Class arbitCouchDbSourceAnnotationFacade

Annotattion facade implementing all methods to access annotations of the source backend.

Implements interfaces:

arbitSourceAnnotationFacade

arbitCouchDbFacadeBase
   |
   --arbitCouchDbSourceAnnotationFacade

Author(s):

Version:	$Revision: 1692 $
License:	GPL

Inherited Member Variables

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

Method Summary

public void	`attachFile( $id , $fileName , $mimeType )` Attach file to annotation Attach a file to the annotation specified by its ID. given as a third parameter and should also be stored.
public mixed	`createAnnotation( $file )` Create a new annotation Create a new annotation with the given ID. if there already is a annotation with the given ID.
public array	`getAnnotationData( $id )` Get annotation data
public array	`getAnnotations( $file )` Get annotations for file Return an array with all annotations for the given file.
public array	`getAnnotationsWithMessage( )` Get all annotations with messages Get annotation list from backend, which do have a message assigned. each annotation the file name it is associated with and the ID is given.
public string	`getFileContents( $id , $fileName )` Get file contents Return the contents of the file specified by its storage file name.
public void	`removeAllAnnotations( )` Remove all annotations Remove all annotations from the source backend.
public void	`updateAnnotationData( $id , $data )` Update stored information for the given annotation 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 annotation Attach a file to the annotation specified by its ID. given as a third parameter and should also be stored.

Attach file to annotation Attach a file to the annotation 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
`arbitSourceAnnotationFacade::attachFile()`	Attach file to annotation Attach a file to the annotation specified by its ID. given as a third parameter and should also be stored.

createAnnotation

mixed createAnnotation( string $file )

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

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

Parameters:

Name	Type	Description
`$file`	string

Implementation of:

Method	Description
`arbitSourceAnnotationFacade::createAnnotation()`	Create a new annotation Create a new annotation with the given ID. if there already is a annotation with the given ID.

getAnnotationData

array getAnnotationData( mixed $id )

Get annotation data

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

id
file
line
position
message
class
link
attachments

Parameters:

Name	Type	Description
`$id`	mixed

Implementation of:

Method	Description
`arbitSourceAnnotationFacade::getAnnotationData()`	Get annotation data

getAnnotations

array getAnnotations( string $file )

Get annotations for file Return an array with all annotations for the given file.

Parameters:

Name	Type	Description
`$file`	string

Implementation of:

Method	Description
`arbitSourceAnnotationFacade::getAnnotations()`	Get annotations for file Return an array with all annotations for the given file.

getAnnotationsWithMessage

array getAnnotationsWithMessage( )

Get all annotations with messages Get annotation list from backend, which do have a message assigned. each annotation the file name it is associated with and the ID is given.

Get all annotations with messages Get annotation list from backend, which do have a message assigned. For each annotation the file name it is associated with and the ID is given.

Implementation of:

Method	Description
`arbitSourceAnnotationFacade::getAnnotationsWithMessage()`	Get all annotations with messages Get annotation list from backend, which do have a message assigned.

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

Implementation of:

Method	Description
`arbitSourceAnnotationFacade::getFileContents()`	Get file contents Return the contents of the file specified by its storage file name.

removeAllAnnotations

void removeAllAnnotations( )

Remove all annotations Remove all annotations from the source backend.

Implementation of:

Method	Description
`arbitSourceAnnotationFacade::removeAllAnnotations()`	Remove all annotations Remove all annotations from the source backend.

updateAnnotationData

void updateAnnotationData( int $id , $data )

Update stored information for the given annotation 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
`arbitSourceAnnotationFacade::updateAnnotationData()`	Update stored information for the given annotation 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:31 +0200 by phpDocumentor 1.4.3