Arbit - project tracking

Arbit - project tracking

API documentation :: Docs For Class arbitModuleModelTrackerIssue

Packages:

Interfaces:

Classes:

Tracker::Model::arbitModuleModelTrackerIssue

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

Class arbitModuleModelTrackerIssue

Project model

Project model

arbitBaseStruct
   |
   --arbitModelBase
      |
      --arbitModuleModelTrackerIssue
Author(s):
Version:   $Revision: 1692 $
License:   GPL

Descendants

Child Class Description
arbitModuleModelImporterIssue Project model

Member Variables

protected string $defaultFetchMethod = 'getIssueData'
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,
'issue' => null,
'issueType' => null,
'title' => null,
'author' => null,
'edited' => null,
'ip' => null,
'text' => null,
'state' => null,
'priority' => null,
'resolution' => null,
'versions' => null,
'scheduled' => null,
'components' => null,
'assigned' => null,
'revisions' => array(),'attachments'=>null,)
Array containing the projects properties

Array containing the projects properties
protected array $userModelProperties = array(
'author',
'assigned',
)
Properties containing user IDs Properties containing user IDs, which should be transformed into user models. current model, all properties with this name are also transformed.

Properties containing user IDs Properties containing user IDs, which should be transformed into user models. If the revision property is set with older revisions of the current model, all properties with this name are also transformed.

Inherited Member Variables

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

Method Summary

public static arbitModuleModelTrackerIssue fetchByNumber( $number )
Fetch issue by issue number Fetch the issue by its issue number and return an arbitModuleModelTrackerIssue object created from that.
public static array fetchIssuesPerMilestone( )
Fetch issue per milestone Returns an array with the milestones as keys and an array of issues for that milestone.
public static array getAllIssues( )
Get issue list Get an array with all issues currently available in the bug tracker.
public void attachFile( $name , $fileName , [ $info = array()] )
Attach file to issue
public mixed create( )
Method called to create a new instance in the backend.
public void delete( )
Method called to delete a instance in the backend.
protected void fixComponentsArray( )
Fix the data structure of the components array.
public array 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.
public string getAttachment( $name )
Get attachment contents Return the contents of the attachment specified by its storage file name.
protected void getIssueData( )
Fetch the basic project data
protected arbitTrackerBackendIniModuleConfiguration getModuleConfiguration( )
Get current module confguration
public array(string=>mixed) getState( )
Returns all the object's properties so that they can be stored or indexed.
public void setState( $properties )
Accepts an array containing data for one or more of the class' properties.
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

fetchByNumber

static arbitModuleModelTrackerIssue fetchByNumber( int $number )

Fetch issue by issue number Fetch the issue by its issue number and return an arbitModuleModelTrackerIssue object created from that.

Fetch issue by issue number Fetch the issue by its issue number and return an arbitModuleModelTrackerIssue object created from that.

Parameters:
Name Type Description
$number int

fetchIssuesPerMilestone

static 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.

getAllIssues

static 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.

attachFile

void attachFile( string $name , string $fileName , [ $info = array()] )

Attach file to issue

Attach file to issue

Parameters:
Name Type Description
$name string
$fileName string
$info array

create

mixed create( )

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.

Redefinition of:
Method Description
arbitModelBase::create() Method called to create a new instance in the backend.
Redefined in descendants as:
Method Description
arbitModuleModelImporterIssue::create() Method called to create a new instance in the backend. 

delete

void delete( )

Method called to delete a instance in the backend.

Method called to delete a instance in the backend. Method called when the model should be deleted in the backend the first time. This will normally throw an error if a model with the given ID does not exist in the backend.

fixComponentsArray

void fixComponentsArray( )

Fix the data structure of the components array.

Fix the data structure of the components array. Fixes the components data structure, as required by issue #99, which is only used to migrate smoothly from 0.2 to 0.3. Can be removed in one of the later versions.

getAffectedUsers

array 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.

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.

getAttachment

string getAttachment( string $name )

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

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

Parameters:
Name Type Description
$name string

getIssueData

void getIssueData( )

Fetch the basic project data

Fetch the basic project data Fetch the basic project data

getModuleConfiguration

arbitTrackerBackendIniModuleConfiguration getModuleConfiguration( )

Get current module confguration

Get current module confguration Get current module confguration

Redefined in descendants as:
Method Description
arbitModuleModelImporterIssue::getModuleConfiguration() Get current module confguration 

getState

array(string=>mixed) getState( )

Returns all the object's properties so that they can be stored or indexed.

Returns all the object's properties so that they can be stored or indexed.

setState

void setState( $properties )

Accepts an array containing data for one or more of the class' properties.

Accepts an array containing data for one or more of the class' properties.

Parameters:
Name Type Description
$properties array

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.
Redefined in descendants as:
Method Description
arbitModuleModelImporterIssue::storeChanges() Method called to store changes to the model. 
Documentation generated on Mon, 05 Apr 2010 14:02:00 +0200 by phpDocumentor 1.4.3

Arbit - project tracking, licensed under GPL 3