Arbit - project tracking, tracked with Arbit

API documentation :: Docs For Class arbitModuleModelSourceAnnotation

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::Model::arbitModuleModelSourceAnnotation

Class arbitModuleModelSourceAnnotation

Project model

arbitBaseStruct
   |
   --arbitModelBase
      |
      --arbitModuleModelSourceAnnotation

Author(s):

Version:	$Revision: 1692 $
License:	GPL

Member Variables

protected string


              $defaultFetchMethod
               =  'getAnnotationData'

Method from the model class implementation used to fetch the requested data value for the constructed model. the data is actually requested from the model.

Method from the model class implementation used to fetch the requested data value for the constructed model. The method is called lazy, when the data is actually requested from the model. The here given method is used, when there is nor special callback defined in the $specialFetchMethods array.

protected array


              $properties
               = array(
        'id'          => null,
        'file'        => null,
        'line'        => null,
        'position'    => null,
        'message'     => null,
        'class'       => null,
        'link'        => null,
        'attachments' => null,
    )

Array containing the projects properties

Inherited Member Variables

From arbitModelBase
protected	`arbitModelBase::$id`
protected	`arbitModelBase::$modifiedProperty`
protected	`arbitModelBase::$specialFetchMethods`
protected	`arbitModelBase::$static`
protected	`arbitModelBase::$userModelProperties`

Method Summary

public static mixed	`deleteAll( $file )` Method called to create a new instance in the backend.
public static array	`getAnnotationsForFile( $file )` Get annotation list for file Get annotation list from backend for the given file.
public static array	`getAnnotationsWithMessage( )` Get all annotations with messages Get annotation list from backend, which do have a message assigned.
public void	`attachFile( $name )` Attach file to annotation
public mixed	`create( $file )` Method called to create a new instance in the backend.
protected void	`getAnnotationData( )` Fetch the basic project data
public string	`getAttachment( $name )` Get attachment contents Return the contents of the attachment specified by its storage file name.
public void	`storeChanges( )` Method called to store changes to the model.

Inherited Methods

From arbitModelBase
public void	`arbitModelBase::__construct()` Create model from identifier If the identifier of the model is known from somewhere in the application you may set it directly here instead of searching for some value.
public abstract void	`arbitModelBase::create()` Method called to create a new instance in the backend.
protected array	`arbitModelBase::getModifiedValues()` Return modified values Return an array with all values which has been modified on the current model instance, with their new values.
public abstract void	`arbitModelBase::storeChanges()` Method called to store changes to the model.
protected mixed	`arbitModelBase::toUserModel()` Transform value to user model(s) Transform a user ID or an array with user IDs in the a user mdoel, or an array of user models.
protected array	`arbitModelBase::transformUserProperties()` Transform all user properties Transform all iser IDs in the declared user properties into user models.
From arbitBaseStruct
protected void	`arbitBaseStruct::deepClone()` Deep clone array structures
public array	`arbitBaseStruct::getProperties()` Get property names Returns an arary with all properties defined in this struct.
public void	`arbitBaseStruct::__clone()` Method called, when struct ist cloned

Methods

deleteAll

static mixed deleteAll( string $file )

Method called to create a new instance in the backend.

Method called to create a new instance in the backend. Method called when the model should be created in the backend the first time. This will normally throw an error if a model with the same identifier already exists in the backend.

Parameters:

Name	Type	Description
`$file`	string

getAnnotationsForFile

static array getAnnotationsForFile( string $file )

Get annotation list for file Get annotation list from backend for the given file.

Parameters:

Name	Type	Description
`$file`	string

getAnnotationsWithMessage

static array getAnnotationsWithMessage( )

Get all annotations with messages Get annotation list from backend, which do have a message assigned.

Get all annotations with messages Get annotation list from backend, which do have a message assigned. Returns an two-dimensional array, where the key is the name of the file, and the value an array of annotation models.

attachFile

void attachFile( string $name )

Attach file to annotation

Parameters:

Name	Type	Description
`$name`	string

create

mixed create( string $file )

Method called to create a new instance in the backend.

Parameters:

Name	Type	Description
`$file`	string

Redefinition of:

Method	Description
`arbitModelBase::create()`	Method called to create a new instance in the backend.

getAnnotationData

void getAnnotationData( )

Fetch the basic project data

Fetch the basic project data Fetch the basic project data

getAttachment

string getAttachment( string $name )

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

Parameters:

Name	Type	Description
`$name`	string

storeChanges

void storeChanges( )

Method called to store changes to the model.

Method called to store changes to the model. Method called to store changes in the model to the backend. The method should only modify the backend data, if something really has been changed in the model. Use the __set() method, which should wrap all write access to the model, to remember write access.

Redefinition of:

Method	Description
`arbitModelBase::storeChanges()`	Method called to store changes to the model.

Documentation generated on Mon, 05 Apr 2010 14:01:29 +0200 by phpDocumentor 1.4.3