Arbit - project tracking, tracked with Arbit

API documentation :: Docs For Class arbitModuleSourceController

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

Class arbitModuleSourceController

Base source controller.

ezcMvcController
   |
   --arbitController
      |
      --arbitModuleSourceController

Author(s):

Version:	$Revision: 1605 $
License:	GPL

Method Summary

public static void	`annotateSource( $signal , $struct )` Handle source annotation signals
public arbitViewModuleModel	`annotations( $request )` Annotation action
public arbitViewModuleModel	`checkout( $request )` Checkout action Display the requested path in the repository.
public arbitViewModuleModel	`diff( $request )` Diff action Display the diff for the given path between the given version numbers.
public arbitViewModuleModel	`emit( $request )` Emit signal action Emits a source updated signal, jsut to trigger other modules.
protected array	`getMenu( )` Return the menu for the source controller
public arbitViewModuleModel	`history( $request )` View action Display the requested path in the repository.
public arbitViewModuleModel	`index( $request )` Index action The index action just dispatches to the default view of the source module - the custom source configuration.
public arbitViewModuleModel	`primeCaches( $request )` Prime cache action Prime all caches file and metadata caches from the VCS backend for faster future access.
protected void	`reportDashboardData( $request , $checkout )` Report data to the dashboard
public void	`revision( $request )` Show revision
public arbitViewModuleModel	`update( $request )` Update action Display the requested path in the repository.
public arbitViewModuleModel	`view( $request )` View action Display the requested path in the repository.

Inherited Methods

From arbitController
public static string	`arbitController::createActionMethodName()` Creates a method name to call from an action name.
public ezcMvcResult\|ezcMvcInternalRedirect	`arbitController::createResult()` Runs the controller to process the query and return variables usable to render the view.
protected void	`arbitController::setRequestVariables()` Don't copy shit here.
public void	`arbitController::__call()` Wrapper for unknown actions Wrapper for unknown actions, which throws an exception instead of causing PHP to report a fatal error.

Methods

annotateSource

static void annotateSource( string $signal , arbitSourceAnnotateStruct $struct )

Handle source annotation signals

Parameters:

Name	Type	Description
`$signal`	string
`$struct`	arbitSignalSlotStruct

annotations

arbitViewModuleModel annotations( $request )

Annotation action

Annotation action Display all annotations containing messages, grouped by files

Parameters:

Name	Type	Description
`$request`	arbitRequest

checkout

arbitViewModuleModel checkout( $request )

Checkout action Display the requested path in the repository.

Parameters:

Name	Type	Description
`$request`	arbitRequest

diff

arbitViewModuleModel diff( $request )

Diff action Display the diff for the given path between the given version numbers.

Parameters:

Name	Type	Description
`$request`	arbitRequest

emit

arbitViewModuleModel emit( $request )

Emit signal action Emits a source updated signal, jsut to trigger other modules.

Parameters:

Name	Type	Description
`$request`	arbitRequest

getMenu

array getMenu( )

Return the menu for the source controller

history

arbitViewModuleModel history( $request )

View action Display the requested path in the repository.

Parameters:

Name	Type	Description
`$request`	arbitRequest

index

arbitViewModuleModel index( $request )

Index action The index action just dispatches to the default view of the source module - the custom source configuration.

Parameters:

Name	Type	Description
`$request`	arbitRequest

primeCaches

arbitViewModuleModel primeCaches( $request )

Prime cache action Prime all caches file and metadata caches from the VCS backend for faster future access.

Parameters:

Name	Type	Description
`$request`	arbitRequest

reportDashboardData

void reportDashboardData( $request , arbitSourceCheckoutViewModel $checkout )

Report data to the dashboard

Parameters:

Name	Type	Description
`$request`	arbitRequest
`$checkout`	arbitSourceCheckoutViewModel

revision

void revision( $request )

Show revision

Show revision Show log and diff for the given revision

Parameters:

Name	Type	Description
`$request`	arbitRequest

update

arbitViewModuleModel update( $request )

Update action Display the requested path in the repository.

Parameters:

Name	Type	Description
`$request`	arbitRequest

view

arbitViewModuleModel view( $request )

View action Display the requested path in the repository.

Parameters:

Name	Type	Description
`$request`	arbitRequest

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