Arbit - project tracking

Arbit - project tracking

API documentation :: Docs For Class arbitProjectFacade

Core::Facade::arbitProjectFacade

Interface arbitProjectFacade

Project facade defining all methods required to access project related data in the backend.

Project facade defining all methods required to access project related data in the backend.

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

Method Summary

public array getProjectData( )
Get project data Return a sorted list with the version strings for the current project.
public void setProjectData( $data )
Set project data Store versions or component array (or both). in the same structure the getProjectData() returns.

Methods

getProjectData

array getProjectData( )

Get project data Return a sorted list with the version strings for the current project.

Get project data Return a sorted list with the version strings for the current project. There should not be any assumptions made on version sorting, but the order should be always returned the same way it has been provided by the user. Each version is associated with its state, which is an integer in (0 = inactive, 1 = active). The returned project data array also contains a list of components, which do not have any structure or order associated. The array looks like:

  1.   array(
  2.       versions => array(
  3.           '0.1' => 0,
  4.           '1.0' => 1,
  5.           ....
  6.       ),
  7.       components => array(
  8.           'website' => array(),
  9.           'project' => array(
  10.               'backend' => array(),
  11.               'frontend' => array(),
  12.           ),
  13.       ),
  14.   ),

setProjectData

void setProjectData( $data )

Set project data Store versions or component array (or both). in the same structure the getProjectData() returns.

Set project data Store versions or component array (or both). The data has to be provided in the same structure the getProjectData() returns. The array looks like:

  1.   array(
  2.       versions => array(
  3.           '0.1' => 0,
  4.           '1.0' => 1,
  5.           ....
  6.       ),
  7.       components => array(
  8.           'website' => array(),
  9.           'project' => array(
  10.               'backend' => array(),
  11.               'frontend' => array(),
  12.           ),
  13.       ),
  14.   ),

Parameters:
Name Type Description
$data array
Documentation generated on Mon, 05 Apr 2010 14:02:13 +0200 by phpDocumentor 1.4.3