Arbit - project tracking, tracked with Arbit

API documentation :: Docs For Class arbitModuleSourceVcsModel

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::arbitModuleSourceVcsModel

Class arbitModuleSourceVcsModel

Project model

Author(s):

Version:	$Revision: 1628 $
License:	GPL

Member Variables

protected vcsCheckout	`$checkout` VCS wrapper Checkount instance VCS wrapper Checkount instance
protected arbitSourceBackendIniModuleConfiguration	`$configuration` Repository configuration Repository configuration
protected string	`$location` Location of the checkout in the filesystem. Location of the checkout in the filesystem. May be passed directly to tools, which cannot handle a PHP RecursiveIterator but are aware of the VCS directories and ignore those.

Method Summary

public void	`__construct( $project , $configuration )` Construct vcs wrapper model Initialises the repository, if not done before.
public void	`checkout( )` Initialize repository Repository initialization may take too long, this should be done using the respective cronjob.
public array	`diff( $path , $from , $to )` Diff two versions of a given resource
protected vcsResource	`getResource( $path )` Get resource from checkout by path
public arbitViewModel	`getViewModel( $path )` Return view model for given path Return a view model for the given path. the repository an exception will be thrown.
public void	`recursivelyPrimeCaches( [ $depth = false] )` Recursively prime caches for checkout Optionally a depth may be specified up to which the caches are primed.
protected int	`toBytes( $string )` Convert size value to bytes
public boolean	`update( [ $revision = null] )` Update repository Repository updates may take too long, this should be done using the respective cronjob.
public array	`versionDiff( $path , [ $version = null] )` Return diff for the given revision Retunrs the diff for the given path for the given revision. will return an array with the prior version, the current version and the actual diff.

Methods

__construct

void __construct( string $project , arbitSourceBackendIniModuleConfiguration $configuration )

Construct vcs wrapper model Initialises the repository, if not done before.

Parameters:

Name	Type	Description
`$project`	string
`$configuration`	arbitSourceBackendIniModuleConfiguration

checkout

void checkout( )

Initialize repository Repository initialization may take too long, this should be done using the respective cronjob.

diff

array diff( string $path , string $from , string $to )

Diff two versions of a given resource

Parameters:

Name	Type	Description
`$path`	string
`$from`	string
`$to`	string

getResource

vcsResource getResource( string $path )

Get resource from checkout by path

Parameters:

Name	Type	Description
`$path`	string

getViewModel

arbitViewModel getViewModel( string $path )

Return view model for given path Return a view model for the given path. the repository an exception will be thrown.

Return view model for given path Return a view model for the given path. If the path does not exist in the repository an exception will be thrown.

Parameters:

Name	Type	Description
`$path`	string

recursivelyPrimeCaches

void recursivelyPrimeCaches( [mixed $depth = false] )

Recursively prime caches for checkout Optionally a depth may be specified up to which the caches are primed.

Recursively prime caches for checkout Optionally a depth may be specified up to which the caches are primed. The default value "false" means unlimited depth.

Parameters:

Name	Type	Description
`$depth`	mixed

toBytes

int toBytes( string $string )

Convert size value to bytes

Parameters:

Name	Type	Description
`$string`	string

update

boolean update( [mixed $revision = null] )

Update repository Repository updates may take too long, this should be done using the respective cronjob.

Update repository Repository updates may take too long, this should be done using the respective cronjob. Returns true if an update happened, and false otherwise.

Parameters:

Name	Type	Description
`$revision`	mixed

versionDiff

array versionDiff( string $path , [string $version = null] )

Return diff for the given revision Retunrs the diff for the given path for the given revision. will return an array with the prior version, the current version and the actual diff.

Return diff for the given revision Retunrs the diff for the given path for the given revision. The method will return an array with the prior version, the current version and the actual diff.

Parameters:

Name	Type	Description
`$path`	string
`$version`	string

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