Arbit - project tracking, tracked with Arbit

API documentation :: Docs For Class arbitModuleCiModelManager

Packages:

Classes:

View
- arbitCiDetailViewModel
- arbitCiOverviewViewModel
- arbitModuleCiXHtmlHandler

Ci::arbitModuleCiModelManager

Class arbitModuleCiModelManager

Model manager of the Continous Interation module, maintaining the stored results and managing the models, which present the results.

Author(s):

Version:	$Revision: 1692 $
License:	GPL

Member Variables

protected static mixed	`$chartModels` Chart models, which are available Additional chart model may be registered using the method registerChartModel, so that external modules may embed additional models. Chart models, which are available Additional chart model may be registered using the method registerChartModel, so that external modules may embed additional models. Each chart model has an array of dependencies on the required module reports assigned.
protected static mixed	`$overviewModels` Overview models, which are available Additional overview model may be registered using the method registerOverviewModel, so that external modules may embed additional models. Overview models, which are available Additional overview model may be registered using the method registerOverviewModel, so that external modules may embed additional models. Each overview model has an array of dependencies on the required module reports assigned.
protected arbitRequest	`$request` Current request context Current request context

Method Summary

public static void	`registerChartModel( $modelClass , $dependencies )` Register chart model Register the model class of a chart model with its dependencies, in the form of:
public static void	`registerOverviewModel( $modelClass , $dependencies )` Register overview model Register the model class of a overview model with its dependencies, in the form of:
public void	`__construct( $request )` Construct model manager from current request context
public void	`availableReports( $report )` Get list of available reports
public array	`getAvailableChartReports( )` Returns instances of chart models based on available reports Returns an array with instances for all chart models, which have been registered and which dependencies are met by available reports.
public array	`getAvailableOverviewReports( )` Returns instances of overview models based on available reports Returns an array with instances for all overview models, which have been registered and which dependencies are met by available reports.
protected array	`getAvailableResults( )` Get a list of available reports Returns an array of results, which are available to the CI module.
protected string	`getBasePath( )` Get base path
public void	`storeResult( $result )` Store result

Methods

registerChartModel

static void registerChartModel( string $modelClass , $dependencies )

array(
array( 'module', 'report' ),
array( 'module', 'report' ),
...
)

Parameters:

Name	Type	Description
`$modelClass`	string
`$dependencies`	array

registerOverviewModel

static void registerOverviewModel( string $modelClass , $dependencies )

array(
array( 'module', 'report' ),
array( 'module', 'report' ),
...
)

Parameters:

Name	Type	Description
`$modelClass`	string
`$dependencies`	array

__construct

void __construct( $request )

Construct model manager from current request context

Parameters:

Name	Type	Description
`$request`	arbitRequest

availableReports

void availableReports( $report )

Get list of available reports

Parameters:

Name	Type	Description
`$report`

getAvailableChartReports

array getAvailableChartReports( )

Returns instances of chart models based on available reports Returns an array with instances for all chart models, which have been registered and which dependencies are met by available reports.

getAvailableOverviewReports

array getAvailableOverviewReports( )

Returns instances of overview models based on available reports Returns an array with instances for all overview models, which have been registered and which dependencies are met by available reports.

getAvailableResults

array getAvailableResults( )

Get a list of available reports Returns an array of results, which are available to the CI module.

Get a list of available reports Returns an array of results, which are available to the CI module. Reports and result, which is at least available once.

getBasePath

string getBasePath( )

Get base path

Get base path Returns the base path of the data storage

storeResult

void storeResult( arbitCiModuleResultStruct $result )

Store result

Store result Store a result reported by some other module

Parameters:

Name	Type	Description
`$result`	arbitCiModuleResultStruct

Documentation generated on Mon, 05 Apr 2010 14:02:03 +0200 by phpDocumentor 1.4.3